Eco Sorter

EcoSorter empowers you to recycle right! This web app guides waste sorting, showcases community recycling leaders, and offers secure accounts to track your impact. Join the fight for a greener planet!

Table of Contents

• Features
• Tech Stack
• Installation
• Screenshots
• License

Features

🗑️ Machine Learning Powered Sorting: EcoSorter employs machine learning algorithms to analyze waste characteristics, ensuring accurate sorting.

📋 Dynamic Community Leaderboard: User sorting data feeds into EcoSorter's machine learning model, continuously refining waste classification and generating an up-to-date leaderboard that reflects the true champions of community recycling.

🔐 Secure User Authentication: Robust authentication protocols safeguard user data and personalize the waste sorting experience, allowing users to track their impact on the environment.

Technology Stack

Screenhots

Installation

Setting up the Express Server

1. Accessing the server/ folder

   cd server
   
   

2. Running the Express App

   • Make sure there is an entry point(index.js)

   • Install the dependencies listed in package.json using:

     npm install
     
     

   • Run the app

     npm run start
     
     

Setting up the FastAPI server

1. Setting up virtual environment

   • Create a new virtual environment using:

     python -m venv venv
     

   • Activate the virtual environment

     venv\Scripts\activate
     

2. Running the FastAPI app

   • Install the required dependencies from requirements.txt using:

      pip install -r requirement.txt
     

   • Start the FastAPI app

     uvicorn app:app --reload
     

Running React App

1. Access the client/ folder in the root of the project

   cd client/
   

2. Running the React App
   • Install all the dependencies in package.json using:

   npm intall
   

• Run the React Application using:

npm run start

License

MIT License

Copyright (c) [2023-24] [Ratul Saha]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.