explain2me

This project is a Chrome extension named "explain2me" that allows users to scrape a web page for text and uses a Large Language Model (LLM) to summarize the page in 250 words. The extension currently only works for public sites.

Usage

1. Clone the repository - change in to directory of your choice and run:

git clone https://github.com/tkmamidi/explain2me.git

2. Navigate to the project directory

cd EXPLAIN2ME/server

3. Setup OpenAI API key

Please signup and create new api key in openAI platform. Create a .env file and add OPENAI_API_KEY="<your-api-key>" with the updated key in the file.

4. Install required packages and run the app

# Install packages
pip install requirements.txt

# Run the app
uvicorn main:app

5. Add the chrome extension

• To use the "explain2me" Chrome extension, simply go to Chrome Extensions tab and turn on the developer mode (top right toggle button).
• Click on "Load unpacked" and navigate to the extension directory of the repo and select it.
• Once installed, you can click on the extension icon on any webpage to open the popup window.
• From there, the extension will scrape the page for text and provide a summary using the Large Language Model (LLM).

Contributing

If you would like to contribute to this project, please follow the guidelines in the CONTRIBUTING.md file.