Skip to content

shift towards sustainability, one purchase swap at a time

Notifications You must be signed in to change notification settings

Ayesha-Imr/SHIFT-Extension

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SHIFT - AI-Powered Browser Extension 🌱

Make your shift towards a more sustainable lifestyle today. SHIFT is a Chrome extension that helps you analyze the sustainability and eco-friendliness of products and discover eco-friendly alternatives. With SHIFT, you can make informed, greener choices effortlessly.

Features

  • Instant Text Extraction: Extract product descriptions from any webpage with a single click.
  • Comprehensive Analysis: Get a detailed sustainability score and eco-friendliness rating for products.
  • Eco-Friendly Alternatives: Discover environmentally friendly alternatives to your current products, complete with purchase options and links.
  • User-Friendly Interface: Enjoy a clean, intuitive interface that makes it easy to access all features and information.

Demo

YouTube Video Title

Installation

From the Chrome Web Store

  1. Visit the Chrome Web Store:

  2. Add to Chrome:

    • Click on the "Add to Chrome" button.
    • Confirm the installation by clicking "Add extension" in the pop-up dialog.
  3. Start Using SHIFT:

    • Click on the SHIFT icon in the Chrome toolbar.
    • Follow the on-screen instructions to analyze products and discover eco-friendly alternatives.

Local Setup Instructions

If you want to set up the SHIFT extension locally for development or testing, follow these steps:

  1. Clone the Repository:

    • Clone the repository to your local machine using the following command:
      git clone https://github.com/Ayesha-Imr/SHIFT-Extension.git
  2. Navigate to the Extension Directory:

  • Change to the extension directory:
    cd SHIFT/extension
  1. Load the Extension in Chrome:

    • Open Chrome and go to chrome://extensions/.
    • Enable "Developer mode" by toggling the switch in the top right corner.
    • Click on the "Load unpacked" button.
    • Select the SHIFT/extension directory.
  2. Start Using SHIFT:

    • Click on the SHIFT icon in the Chrome toolbar.
    • Follow the on-screen instructions to analyze products and discover eco-friendly alternatives.

Backend Setup

The SHIFT extension relies on a backend server for processing product descriptions and providing analysis results. Follow these steps to set up the backend server:

  1. Navigate to the Backend Directory:

    • Change to the backend directory:
      cd SHIFT/backend
  2. Create a Virtual Environment:

    • Create a virtual environment using the following command:
      python -m venv venv
  3. Activate the Virtual Environment:

    • Activate the virtual environment:
      • On Windows:
        venv\Scripts\activate
      • On macOS/Linux:
        source venv/bin/activate
  4. Install Dependencies:

    • Install the required dependencies using the following command:
      pip install -r requirements.txt
  5. Set Up Environment Variables:

    • Create a .env file in the SHIFT/backend directory and add the following environment variables:
      GITHUB_TOKEN=your-github-token
    • This is required to access Github models.
  6. Modify popup.js:

    • Delete the popup.js file in the extension directory, and change the popup.txt file to popup.js instead.
  7. Run the Backend Server:

    • Start the backend server using the following command:
      python app.py

Download SHIFT now and take the first step towards a more sustainable lifestyle!

About

shift towards sustainability, one purchase swap at a time

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published