Nirvana (Shop Green) - README

Introduction

Nirvana is a Google Chrome extension designed to enhance your daily online shopping experience by suggesting eco-friendly alternative products. Our goal is to help you and your body achieve true nirvana by promoting sustainable shopping habits.

Video Preview

nirvana_video.mp4

Tech Stack

• HTML
• CSS
• JavaScript
• Google Search API from SerpAPI

Cloning the Repository

To get started with Nirvana, you need to clone the repository from GitHub. Follow these steps:

Open Terminal (or Command Prompt):

git clone https://github.com/kishlay42/Nirvana-Chrome-Web-Extension-.git

Add Your SerpAPI Key (Required!)

To keep your API key secure and avoid committing it to GitHub:

1. put your api key in popup.js you will find apiurl edit it.

Setting Up the Extension

To set up the Nirvana extension in your Chrome browser, follow these steps:

1. Open Chrome and go to the Extensions page: Navigate to chrome://extensions/ in your Chrome browser.

2. Enable Developer Mode: Toggle the Developer mode switch in the top right corner of the page.

3. Load the Extension: Click on the "Load unpacked" button and select the cloned nirvana-shop-green directory.

Using Nirvana

Once the extension is loaded, you can start using it during your online shopping sessions. The extension will automatically suggest eco-friendly alternatives to the products you are viewing.

Share Your Reviews

We value your feedback! Please share your experience and reviews to help us improve Nirvana. You can submit your feedback via the issues section on our GitHub repository.

Development Phase

Please note that Nirvana is still in its development phase. We are actively working on adding new features and improving the user experience. Stay tuned for updates!

Contributing

We welcome contributions! If you would like to contribute to the project, please fork the repository and create a pull request with your changes.

Thank you for choosing Nirvana and joining us on the journey to sustainable living!

Add Your SerpAPI Key:

• Sign up on SerpAPI to get your API key.
• Open the config.js file in the cloned directory.
• Add your SerpAPI key:

  const serpApiKey = 'YOUR_SERPAPI_KEY';