{"id":29636449,"url":"https://github.com/codellyson/onesec-summary","last_synced_at":"2025-07-21T17:04:10.771Z","repository":{"id":305244262,"uuid":"1021856941","full_name":"codellyson/onesec-summary","owner":"codellyson","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-18T23:33:15.000Z","size":145,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-07-19T03:59:24.161Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codellyson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-18T04:08:42.000Z","updated_at":"2025-07-18T23:33:19.000Z","dependencies_parsed_at":"2025-07-19T04:12:38.606Z","dependency_job_id":null,"html_url":"https://github.com/codellyson/onesec-summary","commit_stats":null,"previous_names":["codellyson/onesec-summary"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/codellyson/onesec-summary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codellyson%2Fonesec-summary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codellyson%2Fonesec-summary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codellyson%2Fonesec-summary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codellyson%2Fonesec-summary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codellyson","download_url":"https://codeload.github.com/codellyson/onesec-summary/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codellyson%2Fonesec-summary/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266341357,"owners_count":23914227,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-21T11:47:31.412Z","response_time":64,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-21T17:04:09.774Z","updated_at":"2025-07-21T17:04:10.756Z","avatar_url":"https://github.com/codellyson.png","language":"TypeScript","readme":"# 🧠 OneSec Summary\n\nA Chrome Extension that gives you a 1-sentence summary of any web page using AI.\n\n## ✨ Features\n\n- **One-Click Summarization**: Get instant summaries with a single button click\n- **Smart Text Extraction**: Automatically extracts and cleans page content\n- **AI-Powered**: Uses advanced AI models for accurate, concise summaries\n- **Beautiful UI**: Modern, responsive design with smooth animations\n- **Cross-Platform**: Works on any website\n- **Side Panel Interface**: Opens directly in a side panel for persistent access while browsing\n\n## 🚀 Quick Start\n\n### Development\n\n1. **Install dependencies**:\n\n   ```bash\n   pnpm install\n   ```\n\n2. **Start development server**:\n\n   ```bash\n   pnpm dev\n   ```\n\n3. **Load the extension**:\n   - Open Chrome and go to `chrome://extensions/`\n   - Enable \"Developer mode\"\n   - Click \"Load unpacked\" and select the `.output/chrome-mv3` folder\n\n### Using the Extension\n\n1. **Open Side Panel**: Click the extension icon in the toolbar to open the side panel\n2. **Summarize**: Click \"📄 Summarize This Page\" to get an AI-generated summary of the current webpage\n3. **Persistent Access**: The side panel stays open while you browse, allowing you to summarize multiple pages\n\n### Building for Production\n\n```bash\npnpm build\n```\n\nThe built extension will be in the `dist` folder.\n\n## 🔧 Configuration\n\n### AI Integration\n\nThe extension currently uses mock AI responses for development. To integrate with real AI services:\n\n1. **OpenAI Integration**:\n\n   - Set your OpenAI API key in the environment variables\n   - Uncomment the OpenAI API call in `entrypoints/lib/ai-service.ts`\n\n2. **Hugging Face Integration**:\n   - Set your Hugging Face token in the environment variables\n   - Use the `summarizeWithHuggingFace` method in the AI service\n\n### Environment Variables\n\nCreate a `.env` file in the root directory:\n\n```env\nOPENAI_API_KEY=your_openai_api_key_here\nHF_TOKEN=your_huggingface_token_here\n```\n\n## 📁 Project Structure\n\n```\nonesec-summary/\n├── entrypoints/\n│   ├── popup/           # Extension popup (auto-opens side panel)\n│   │   ├── App.tsx      # Popup React component\n│   │   ├── App.css      # Styles for the popup\n│   │   └── main.tsx     # Popup entry point\n│   ├── side-panel/      # Main side panel UI\n│   │   ├── App.tsx      # Side panel React component\n│   │   ├── App.css      # Styles for the side panel\n│   │   ├── main.tsx     # Side panel entry point\n│   │   ├── index.html   # Side panel HTML\n│   │   └── style.css    # Global styles for side panel\n│   └── lib/\n│       └── ai-service.ts # AI integration service\n├── public/              # Static assets\n├── wxt.config.ts        # WXT configuration\n└── package.json         # Dependencies and scripts\n```\n\n## 🎨 UI Components\n\n- **Header**: App title and subtitle with gradient background\n- **Welcome Section**: Initial state with instructions\n- **Loading Section**: Animated spinner during processing\n- **Summary Section**: Displays the generated summary\n- **Error Section**: Shows error messages when something goes wrong\n- **Action Buttons**: Primary summarize button and secondary actions\n- **Side Panel Interface**: Optimized layout for the side panel with persistent access\n\n## 🔒 Permissions\n\nThe extension requires the following permissions:\n\n- `activeTab`: To access the current tab's content\n- `scripting`: To execute content scripts for text extraction\n- `storage`: For potential future features (settings, history)\n- `sidePanel`: To open the extension in a side panel\n- `\u003call_urls\u003e`: To work on any website\n\n## 🛠️ Development\n\n### Tech Stack\n\n- **Framework**: React 19 with TypeScript\n- **Build Tool**: WXT (Web Extension Toolkit)\n- **Styling**: CSS with modern features (gradients, animations)\n- **AI Integration**: Configurable service layer\n\n### Available Scripts\n\n- `pnpm dev`: Start development server\n- `pnpm build`: Build for production\n- `pnpm zip`: Create a zip file for distribution\n- `pnpm compile`: Type-check the codebase\n\n## 🤝 Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Test thoroughly\n5. Submit a pull request\n\n## 📝 License\n\nMIT License - see LICENSE file for details\n\n## 🆘 Support\n\nIf you encounter any issues or have questions:\n\n1. Check the browser console for error messages\n2. Ensure you have the necessary permissions enabled\n3. Verify your AI API keys are correctly configured\n4. Open an issue on GitHub with detailed information\n\n## 🔮 Future Enhancements\n\n- [ ] Save summary history\n- [ ] Custom summary length options\n- [ ] Multiple AI model support\n- [ ] Keyboard shortcuts\n- [ ] Summary sharing features\n- [ ] Dark/light theme toggle\n- [ ] Offline mode with cached summaries\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodellyson%2Fonesec-summary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodellyson%2Fonesec-summary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodellyson%2Fonesec-summary/lists"}