A scalable waste management system powered by IoT.

1. cleanurge-mcu: Containing the source code for the microcontroller
2. cleanurge-backend: Containing the source code for the Express backend
3. cleanurge-app: Containing the source code for the Android App

This is the repo for the app part of project Cleanurge

1. Description
2. Project structure
3. Project roadmap
4. Getting started
5. Live demo
6. Built with
7. Contributing
8. Authors
9. License
10. Acknowledgments

Today, waste is a significant global issue. Increasing volumes of waste are being generated as the global population and living standards rise. The environmental impact is significant, with massive volumes of waste generated annually with only basic or little treatment to minimise its impact. People are increasingly concerned about the production of waste and its effect, and are seeking ways to deal with the problem.

Our project serves to prevent overaccumulation of waste at public bins by maintaining a log of their waste accumulation levels. The authorities will have the feature to get live status of the various public bins and appoint garbagemen to clear off any bins on overaccumulation. Moreover, the local residents will be able to report if there is an urgent attention needed in case of an overflow outside the garbage bins or excess accumulation of wastes nearby.

The idea is to have wireless beacons configured at various public bins to detect and measure the level of waste accumulation at the bins. When the level at any of the bins cross a threshold, a request is triggered to a web server that is then used to send notifications to the authorities in an app as well as web based software. The mobile application also supports the feature for individuals living in the locality to report of any waste accumulation directly to the authorities.

This repository hosts only the hardware side code

/
  ├── .github/            github related files like PR templates, contribution guidelines
  ├── .gitignore          stores files and directories to be ignored in commits
  ├── LICENSE             the open source license
  ├── code_of_conduct.md  code of conduct for open source contribution
  ├── contributing.md     contribution guidelines
  └── readme.md           details and instructions about the project go here

TODO: Features to be updated

The project currently does the following things.

• Feature 1
• Feature 2
• Feature 3

See below for our future steps.

• Feature 1
• Feature 2
• Feature 3

Everyone is welcomed to contribute to our project. Mentioning in bold, you do not need to know the tech stack and tools beforehand to be a part of our project. This is a learn-and-build projects where the contributors build alongside learning the various concepts and technologies involved. Below are a few prerequisites and installation guides:

• Android Studio
• JDK 8+

The best way to learn the following is to google each and everything!

• Very basic understanding of git and github:

  • What are repositories (local - remote - upstream), issues, pull requests
  • How to clone a repository, how to fork a repository, how to set upstreams
  • Adding, committing, pulling, pushing changes to remote repositories

A step by step series of instructions that tell you how to get the project running locally is given below. Google every issue you face following the below instructions or just ask us in our Discord / WhatsApp group.

TODO: deploy over heroku or netlify or some other platform with CI/CD support

• JAVA
• Android Studio 4.1
• Retrofit

Please read contributing.md for details on our code of conduct, and the process for submitting pull requests to us.

This project is licensed under the GNU Public License - see the LICENSE file for details.

contributors-img