pyesonekyaw / RecycleTree

RecycleTree - One-stop Portal for Recycling in Singapore - Built with Next.js, TailwindCSS, Supabase and HuggingFace Spaces

Enabling you to smart recycling in our smart nation!

View Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

RecycleTree is a project from CZ3002 Advanced Software Engineering in Nanyang Technological University. It aims to enable users to have a more informed recycling experience, from finding the nearest recycling bins, to checking whether the item they wish to recycle can indeed be recycled, to learning more about recycling and contamination in general.

RecycleTree has three main components:

• RecycleGoWhere - Finding the nearest recycling bins to the user's location based on data provided by data.gov.sg
• RecycleCanMeh - Checking if the item to be recycled can indeed be recycled based on image classification models
• RecycleHowAh - Learning more about recycling and contamination of recyclables

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• React
• Next.js
• Huggingface
• Supabase

Test framework:

Getting Started

1. Get a Google Maps API Key

2. Create a Supabase project

3. Create a HuggingFace account

4. Clone the repo

5. Install NPM packages

   npm install

6. Save your API keys from Google Maps, Supabase, and HuggingFace in a .env file

7. Create a HuggingFace Space and replace the necessary links inside the codebase

8. Run the development server:

   npm run dev
   # or
   yarn dev
   # or
   pnpm dev

Contributors

• Pye Sone Kyaw
• Kasidis Chantharojwong
• Le Quang Anh
• Cheng Zhengjie
• Flora Lam Wen Hui
• Lin Lejia
• Shang Ziyuan