Skip to content

Tristanv0/EcoDex

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation


drawing

EcoDex

Gamified platform designed to help users understand and manage waste more effectively by scanning and contributing to environmental sustainability.
Video Demo · Features · Installation · Tech Stack · Contributers

What is EcoDex? About

drawing


EcoDex, is a gamified platform that helps users understand and manage waste more effectively. By allowing users to scan waste, it provides information on the type of waste, proper disposal methods, environmental impact, and other waste information. This interactive approach aims to educate users and promote better waste management practices.

Video Demo Demo

EcoDex.Demo.mp4

Features Contributors

  • Image/object recognition
  • Generating information based on object recognition
  • Storing past objects in database
  • Points system (earning and redeeming points)
  • User Profile

Contributors Contributors

Technologies Used Technologies

Frontend

Next JS TailwindCSS NodeJS JavaScript

Backend

Python Flask MongoDB OpenAI Imgur

Installation Installation

# Clone this repository
$ git clone https://github.com/josephleungg/EcoDex

# Go into the backend folder
$ cd EcoDex/server

# install virtual environment
$ python3 -m venv .venv # for linux
> py -3 -m venv .venv   # for windows

# make sure you activate virtual environment
$ source .venv/bin/activate # for linux
> .venv\Scripts\activate # for windows

# install necessary dependencies
$ pip install -r requirements.txt

# go to the frontend folder
$ cd ../client

# install necessary packages
$ npm install # using npm
$ bun install # using bun
$ pnpm install # using pnpm
$ yarn install # using yarn

# run the development server and go to localhost:3000
$ npm run dev
$ bun run dev
$ pnpm run dev
$ yarn run dev

# run the server
$ cd ../server
$ python app.py

About

hackathon project for TerraHacks 2024

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 73.9%
  • Python 24.8%
  • CSS 1.3%