Skip to content

yactouat/SWS_waste-sorter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Strasbourg Waste Sorter (SWS)

what is this ?

This repo holds the api and frontend code of a waste sorter app' that consists of recognizing waste items in order to tell in which bin they need to be thrown. Currently, we only support the Strasbourg area, but we plan on expanding to other cities in the future.

CI/CD

There's a CI/CD pipeline in place that builds the Docker image and pushes it to the GCP Artifact Registry, all the way to deployment in a Cloud Run container (check out ./.github/workflows/cicd.yml). Remember to build the app' before deploying it.

Frontend contributions

When making a PR changing the React frontend, don't forget to run npm run build before pushing your changes, otherwise the deployed app' static assets won't change.

Contribution guidelines

dear past, present, and future contributors, you have my many thanks, but:

  • please use comments to explain your code, even if it's obvious to you, it might not be to someone else
  • you are free to arrange the code, the folder structure, the file names, etc. as you see fit if you're able to provide a good reason for it

that's all, thank you for your time !

Code Viz

https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=yactouat%2FSWS_waste-sorter

Contributors

a big thanks goes to the contributors of this project:

yactouat
yactouat
Ritik Raj
Ritik Raj
Aharon Karsenti
Aharon Karsenti
etnms
etnms