Skip to content

ContentSnap is a powerful browser extension that leverages cutting-edge NLP models to summarize web articles, blogs, and research papers into easy-to-digest formats — all in one click.

License

Notifications You must be signed in to change notification settings

InflixOP/ContentSnap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📄 ContentSnap – Smart Article Summarizer Extension

ContentSnap is a powerful NLP-driven browser extension that lets you summarize long articles, blog posts, or research papers into digestible formats — instantly. Whether you're short on time or just want the TL;DR, ContentSnap helps you read smarter, not harder.


✨ Features

  • 🔹 One-click summarization of any webpage text
  • 🔹 Multiple summary formats:
    • Bullet Points
    • TL;DR (Too Long; Didn't Read)
    • Simplified Explanation
    • Key Insights
  • 🔹 Real-time article parsing and intelligent content extraction
  • 🔹 Cross-browser support: Chrome, Firefox, and Edge
  • 🔹 Offline capable with local NLP processing
  • 🔹 Privacy-focused: No data sent to external servers
  • 🔹 Customizable summary length (Short, Medium, Detailed)
  • 🔹 Pegasus AI Model for superior summarization quality

🚀 Installation

Method 1: Install from GitHub Releases (Recommended)

Step 1: Start the Backend Server

  1. Navigate to the backend folder:
    • After extracting the ZIP file, you'll find two folders: backend and extension
    • Open a terminal/command prompt in the backend folder
  2. Install dependencies (if needed):
    pip install -r requirements.txt
  3. Start the backend server:
    python app.py
    • Keep this terminal window open - the backend server must be running for the extension to work
    • You should see a message indicating the server is running (typically on http://localhost:5000)

Step 2: Download and Extract the Extension

  1. Download the latest release:
    • Go to Releases
    • Download ContentSnap-v[version]-extension.zip
    • Extract the ZIP file

Step 3: Install the Browser Extension

For Chrome/Edge:

  • Open chrome://extensions/ (or edge://extensions/)
  • Enable "Developer mode" (toggle in top-right)
  • Click "Load unpacked"
  • Select the extension folder (not the main ContentSnap folder)
  • Pin the extension to your toolbar

For Firefox:

  • Open about:debugging
  • Click "This Firefox"
  • Click "Load Temporary Add-on"
  • Select manifest.json from the extension folder

Important Notes:

  • Backend must be running: Always start the backend server (python app.py) before using the extension
  • Two folders: The main ContentSnap folder contains both backend and extension folders
  • Select the right folder: When loading the extension, select the extension folder, not the main ContentSnap folder

Method 2: Build from Source

# Clone the repository  
git clone https://github.com/InflixOP/ContentSnap.git
cd ContentSnap

# Install dependencies (if any)
npm install

# Build the extension (if build process exists)
npm run build

# Follow installation steps above with the built folder

🧰 Tech Stack

Component Technology
Frontend HTML5, CSS3, Vanilla JavaScript
Extension API Chrome Extensions API v3
NLP Processing TensorFlow.js, Web Workers
Models Google Pegasus, DistilBART, TinyBERT (optimized for browser)
Storage Chrome Storage API
Permissions activeTab, storage

📖 How to Use

  1. Navigate to any article, blog post, or text-heavy webpage
  2. Click the ContentSnap icon in your browser toolbar
  3. Choose your preferred summary format:
    • 📝 Bullet Points - Key points in list format
    • TL;DR - Ultra-quick summary
    • 🧠 Simplified - Easy-to-understand explanation
  4. Adjust summary length if needed
  5. Copy or Save your summary

🔧 Configuration

Access settings by clicking the gear icon in the extension popup:

  • Summary Length: Short (2-3 sentences) | Medium (1 paragraph) | Detailed (2-3 paragraphs)
  • Auto-detect Language: Enable multilingual support
  • Dark Mode: Toggle dark/light theme
  • Keyboard Shortcuts: Customize hotkeys

🤝 Contributing

We welcome contributions! Here's how you can help improve ContentSnap:

🐛 Report Issues

💻 Development Setup

  1. Fork the repository
git clone https://github.com/InflixOP/ContentSnap.git
cd ContentSnap
  1. Create a feature branch
git checkout -b feature/amazing-feature
  1. Make your changes and test

    • Test the extension in different browsers
    • Ensure summary quality remains high
    • Check for performance issues
  2. Submit a Pull Request

    • Provide clear description of changes
    • Include screenshots if UI changes
    • Reference any related issues

📄 License

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


If ContentSnap saves you time, consider giving it a ⭐ star!