/SummaRead

SummaRead combines the simplicity of a clean reading mode with the intelligence of AI-based summarization, transforming the way you engage with online content.

Primary LanguageTypeScriptMIT LicenseMIT

SummaRead ๐Ÿ“šโœจ

Introducing SummaRead - A Chrome extension that enhances your online reading experience by providing a clutter-free environment and AI-powered summaries. SummaRead is designed to be minimalistic, simple, straightforward, and very easy to use. It declutters articles, removes ads, and delivers quick summaries to help you stay informed and focused. Experience a more enjoyable and efficient reading journey with SummaRead, your smart reading assistant.

Note: This project is in its initial stages and is not yet complete. I'm actively working on improvements and new features, so stay tuned for updates!

SummaRead Banner

Key Features ๐Ÿš€

  • Clutter-Free Reading ๐Ÿงน: Automatically remove ads, pop-ups, and distracting elements from articles, leaving only the main text and relevant media.
  • AI-Powered Summaries ๐Ÿค–: Generate concise and accurate summaries of articles with the power of AI, providing an overview and saving time.
  • Customizable Appearance ๐ŸŽจ: Easily switch between light and dark themes for optimal readability, and adjust text size with simple +/- buttons.
  • Quick Toggle ๐Ÿ”˜: Enable or disable SummaRead with a single click using the convenient toggle button in the browser toolbar.
  • Article Detection ๐Ÿ”: SummaRead automatically detects when you're viewing an article or blog post, prompting you to enable the extension.

Tech Stack ๐Ÿ’ป

SummaRead Banner

  • Frontend: React.js
  • Backend: Node.js

Getting Started ๐Ÿš€

SummaRead Getting Started

Prerequisites

  • Node.js and npm installed on your machine

Installation

  1. Clone the repository

    git clone https://github.com/antoinekllee/SummaRead.git
    
  2. Navigate to the project directory

    cd SummaRead
    
  3. Install dependencies

    npm install
    
  4. Build the project

    npm run build
    
  5. Load the extension in Chrome

    • Open the Chrome Extensions page (chrome://extensions/)
    • Ensure that the "Developer mode" toggle is turned on in the top right corner
    • Click the "Load unpacked" button in the top left corner and select the dist folder in your project directory
  6. Start the development server with live reloading (optional)

    npm start
    

Note: To see the live-reloaded changes, you will need to manually reload the extension in Chrome after each build. To do this, click the "Reload" button (circular arrow) on your extension card in the chrome://extensions/ page.

License ๐Ÿ“„

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

Experience the power of AI-based summarization and a clean reading experience with SummaRead! ๐ŸŽ‰๐Ÿ“–