summarizer-Chrome-extentsion Svelte Themes

Summarizer Chrome Extentsion

A Chrome extension that leverages Groq’s LLaMA 3 70B model to generate AI-powered summaries and quizzes for any web page. Instantly understand key points, test your comprehension with interactive questions, and save important content — all while keeping your data private and stored locally.

📚 What Did I Just Read?

What Did I Just Read? Logo

Transform how you read online with AI-powered summaries and quizzes

InstallationFeaturesHow to UseDevelopmentContributing


🚀 Features

📝 AI-Powered Summaries

Get concise summaries of articles and web pages using Groq's state-of-the-art LLaMA 3 70B model.

🎯 Interactive Quizzes

Test your understanding and retention with automatically generated quizzes based on the content you've read.

📊 Performance Analytics

Gain insights into your reading habits and quiz performance with detailed statistics.

✨ Floating TL;DR Button

Quick access to summaries directly on web pages without needing to open the extension popup.

🌙 Dark Mode Support

Enjoy comfortable reading in all lighting conditions with automatic theme detection.

🔒 Privacy-Focused

All your data is stored locally by default. Your reading history never leaves your device.


📋 How to Use

  1. Browse to any article or content-heavy web page
  2. Get a summary using one of two ways:
    • Click the "What Did I Just Read?" extension icon in your browser toolbar
    • Use the floating TL;DR button that appears on the page
  3. Review the AI-generated summary with key points and detailed explanations
  4. Test yourself by generating a quiz based on the content
Extension Screenshot

The extension in action (placeholder image)


💻 Installation

From Chrome Web Store (Coming Soon)

  1. Visit the Chrome Web Store (link coming soon)
  2. Click "Add to Chrome"
  3. Confirm the installation

Manual Installation

  1. Download the latest release (or follow the development setup below)
  2. Open Chrome and navigate to chrome://extensions
  3. Enable "Developer mode" in the top-right corner
  4. Click "Load unpacked" and select the extracted ZIP directory

🛠️ Development

Prerequisites

Setup

  1. Clone the repository

    git clone https://github.com/rk-vashista/summarizer-Chrome-extentsion
    cd what-did-i-just-read
    
  2. Install dependencies

    npm install
    
  3. Create a .env file with your Groq API key

    echo "GROQ_API_KEY=your-groq-api-key-here" > .env
    
  4. Start the development server

    npm run dev
    

Building for Development

npm run build:extension

This will build the extension files for testing in Chrome.

Building for Production

npm run build:all

This creates a production-ready build in the build directory.

Packaging for Distribution

npm run package

Creates a ZIP file suitable for Chrome Web Store submission.


📦 Tech Stack

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

📁 Project Structure

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

📜 Available Scripts

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

👥 Contributing

Contributions are welcome and appreciated! Here's how to get started:

  1. Fork the repository
  2. Clone your fork locally:
    git clone https://github.com/rk-vashista/summarizer-Chrome-extentsion
    
  3. Create a feature branch:
    git checkout -b feature/amazing-feature
    
  4. Make your changes
  5. Commit with descriptive messages:
    git commit -m 'Add some amazing feature'
    
  6. Push to your branch:
    git push origin feature/amazing-feature
    
  7. Open a Pull Request

Please ensure your code follows the project's style guidelines and includes appropriate tests.


📄 License

This project is licensed under the MIT License - see the LICENSE file for details.


Made with ❤️ by [Your Name/Team]

Top categories

Loading Svelte Themes