myTrash

myTrash is a waste management solution designed to streamline the reporting of overloaded trash bins in public gardens, contributing to cleaner and more efficient waste collection in Paris.

📃 Table of Contents

• myTrash
  • 📃 Table of Contents
  • About the project
    • ℹ️ Project Description
    • 👥 Team members
  • Getting Started
    • ⚙️ Prerequisites
    • 🚦 Run the Project
  • 📝 Additional Notes

About the project

Note

This project falls within the scope of the Interdisciplinary Project for the third year curriculum at EFREI, which is a French CS engineering school.

ℹ️ Project Description

myTrash aims to design a solution for reporting overloaded trash bins in public gardens in Paris. The goal is to address the issue of overflowing trash bins by providing a mechanism for individuals to easily signal when a bin is full. This will allow the city to better manage waste collection and ensure that public spaces remain clean and safe for everyone. This will also allow the trash company to make fewer unnecessary trips to empty bins that are not full, reducing costs and environmental impact.

The project leverages a modern web development stack:

• Backend: It utilizes Node.js with Express.js a fast, unopinionated, minimalist web framework and TypeScript for type safety. Prisma ORM simplifies database interactions with PostgreSQL.
• Frontend: It's built with React.js for a reactive and component-based user interface, enhanced with CSS for styling.

👥 Team members

• P4ND4P0W3R - Paul HU
• Cyrilnkl - Cyril NAKHLA
• alinahas1311 - Ali NAHAS
• Eyfeline - Eyfeline TALA
• flouis78 - Louis FABRE
• nkrief4 - Nathan KRIEF
• Thomas94800 - Thomas CALVO

Getting Started

⚙️ Prerequisites

Make sure you have the following installed before proceeding:

• Node.js (v18 or higher)
• npm or Yarn

🚦 Run the Project

Follow these steps to run the project locally:

1. Clone the repository:

   git clone https://github.com/P4ND4P0W3R/myTrash.git

2. Navigate to the project directory:

   cd myTrash

3. Start Server-side:

   • Navigate to the server directory, install its dependencies and run the server using the following commands:

   # In the /root directory
   cd server
   npm install   # or yarn install
   npm run dev   # or yarn dev

   This should install the server's dependencies and start your Express server on the port 3000 and accessible on http://localhost:3000.

4. Start Client-side:

   • Navigate to the client directory, install its dependencies and run the client using the following command:

   # In the /root directory
   cd /client
   npm install   # or yarn install
   npm run dev   # or yarn dev

   This should install the client's dependencies and start your Vite development server for the React app on the port 5173 and accessible on http://localhost:5173.

📝 Additional Notes

• Project Status: This project is currently in development.
• Mobile App: We are exploring options for developing a mobile app version of myTrash.