https://github.com/p4nd4p0w3r/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.
https://github.com/p4nd4p0w3r/mytrash
2024 efrei interdisciplinary-project l3 paris s6 trash
Last synced: 12 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/p4nd4p0w3r/mytrash
- Owner: P4ND4P0W3R
- Created: 2024-02-12T15:20:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-30T18:09:49.000Z (about 1 year ago)
- Last Synced: 2025-04-30T19:26:39.424Z (about 1 year ago)
- Topics: 2024, efrei, interdisciplinary-project, l3, paris, s6, trash
- Language: TypeScript
- Homepage:
- Size: 2.13 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](#mytrash)
- [đ Table of Contents](#-table-of-contents)
- [About the project](#about-the-project)
- [âšī¸ Project Description](#âšī¸-project-description)
- [đĨ Team members](#-team-members)
- [Getting Started](#getting-started)
- [âī¸ Prerequisites](#ī¸-prerequisites)
- [đĻ Run the Project](#-run-the-project)
- [đ Additional Notes](#-additional-notes)
## About the project
> [!NOTE]
> This project falls within the scope of the **Interdisciplinary Project** for the third year curriculum at [EFREI](https://www.efrei.fr/), 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](https://nodejs.org/en) with [Express.js](https://expressjs.com/) a fast, unopinionated, minimalist web framework and [TypeScript](https://www.typescriptlang.org/) for type safety. [Prisma ORM](https://www.prisma.io/) simplifies database interactions with [PostgreSQL](https://www.postgresql.org/).
- Frontend: It's built with [React.js](https://react.dev/) for a reactive and component-based user interface, enhanced with CSS for styling.
### đĨ Team members
- [P4ND4P0W3R](https://github.com/P4ND4P0W3R) - Paul HU
- [Cyrilnkl](https://github.com/Cyrilnkl) - Cyril NAKHLA
- [alinahas1311](https://github.com/alinahas1311) - Ali NAHAS
- [Eyfeline](https://github.com/Eyfeline) - Eyfeline TALA
- [flouis78](https://github.com/flouis78) - Louis FABRE
- [nkrief4](https://github.com/nkrief4) - Nathan KRIEF
- [Thomas94800](https://github.com/Thomas94800) - Thomas CALVO
## Getting Started
### âī¸ Prerequisites
Make sure you have the following installed before proceeding:
- [Node.js](https://nodejs.org/en) (v18 or higher)
- [npm](https://www.npmjs.com/) or [Yarn](https://yarnpkg.com/)
### đĻ Run the Project
Follow these steps to run the project locally:
1. **Clone the repository:**
```bash
git clone https://github.com/P4ND4P0W3R/myTrash.git
```
2. **Navigate to the project directory:**
```bash
cd myTrash
```
3. **Start Server-side:**
- Navigate to the `server` directory, install its dependencies and run the server using the following commands:
```bash
# 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](http://localhost:3000).
4. **Start Client-side:**
- Navigate to the `client` directory, install its dependencies and run the client using the following command:
```bash
# 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](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.