Transform how you read online with AI-powered summaries and quizzes
Installation • Features • How to Use • Development • Contributing
📝 AI-Powered SummariesGet concise summaries of articles and web pages using Groq's state-of-the-art LLaMA 3 70B model. |
🎯 Interactive QuizzesTest your understanding and retention with automatically generated quizzes based on the content you've read. |
|
📊 Performance AnalyticsGain insights into your reading habits and quiz performance with detailed statistics. |
✨ Floating TL;DR ButtonQuick access to summaries directly on web pages without needing to open the extension popup. |
|
🌙 Dark Mode SupportEnjoy comfortable reading in all lighting conditions with automatic theme detection. |
🔒 Privacy-FocusedAll your data is stored locally by default. Your reading history never leaves your device. |
The extension in action (placeholder image)
chrome://extensions
Clone the repository
git clone https://github.com/rk-vashista/summarizer-Chrome-extentsion
cd what-did-i-just-read
Install dependencies
npm install
Create a .env
file with your Groq API key
echo "GROQ_API_KEY=your-groq-api-key-here" > .env
Start the development server
npm run dev
npm run build:extension
This will build the extension files for testing in Chrome.
npm run build:all
This creates a production-ready build in the build
directory.
npm run package
Creates a ZIP file suitable for Chrome Web Store submission.
Category | Technologies |
---|---|
Frontend | Svelte 5, SvelteKit, Tailwind CSS |
AI | Groq API, LLaMA 3 70B model |
Storage | IndexedDB (via idb-keyval) |
Text Processing | Mozilla's Readability.js |
Browser Integration | Chrome Extension Manifest V3 |
src/
├── background/ # Background scripts for Groq API communication
├── content/ # Content scripts that run on web pages
├── popup/ # Extension popup UI components
├── summarizer/ # Text summarization logic using Groq
├── quiz/ # Quiz generation algorithms
├── storage/ # Local storage management (IndexedDB)
├── utils/ # Utility and helper functions
├── routes/ # SvelteKit routes
└── assets/ # Extension icons and images
Command | Description |
---|---|
npm run dev |
Start SvelteKit development server |
npm run build |
Build SvelteKit app |
npm run build:extension |
Build Chrome extension files |
npm run build:all |
Build both SvelteKit app and extension |
npm run package |
Create ZIP file for distribution |
npm run format |
Format code with Prettier |
npm run lint |
Check code formatting |
Contributions are welcome and appreciated! Here's how to get started:
git clone https://github.com/rk-vashista/summarizer-Chrome-extentsion
git checkout -b feature/amazing-feature
git commit -m 'Add some amazing feature'
git push origin feature/amazing-feature
Please ensure your code follows the project's style guidelines and includes appropriate tests.
This project is licensed under the MIT License - see the LICENSE file for details.
Made with ❤️ by [Your Name/Team]