WasteEasy
WasteEasy is an app designed to streamline waste management. Developed during the Envision Hackathon, it focuses on waste classification and encourages proper waste segregation. Users can earn points or coupons by utilizing WasteEasy for their waste disposal needs.
Install / Use
/learn @ShivaBhattacharjee/WasteEasyREADME
Table Of Contents
- Table Of Contents
- About The Project
- Built With
- Getting Started
- Host your own
- Contributing
- Raising an issue
- Code of conduct
- License
- Authors
About The Project
WasteEasy is an app designed to streamline waste management. Developed during the Envision Hackathon, it focuses on waste classification and encourages proper waste segregation. Users can earn points or coupons by utilizing WasteEasy for their waste disposal needs.
Built With
Getting Started
Prerequisites
<a href="https://git-scm.com/downloads" >Git</a> is a distributed version control system used for software development. It allows multiple developers to work on the same codebase simultaneously, keeping track of changes and managing versions. It also enables users to revert changes and collaborate more effectively.
<a href="https://bun.sh/">Bun</a> is a JavaScript runtime, package manager, test runner bundler built from scratch using the Zig programming language. It was designed by Jarred Sumner as a drop-in replacement for Node.js. Bun uses JavaScriptCore as the JavaScript engine, unlike Node.js and Deno, which both use V8.
<a href="https://www.mongodb.com//">MongoDB</a> is a source-available, cross-platform, document-oriented database program. Classified as a NoSQL database product, MongoDB utilizes JSON-like documents with optional schemas. MongoDB is developed by MongoDB Inc. and current versions are licensed under the Server Side Public License.
<a href="https://developers.google.com/maps/documentation/javascript/get-api-key">GoogleMaps Api key</a>
<a href="https://makersuite.google.com/app/apikey">Gemini Api Key</a>
<a href="https://www.emailjs.com/">EmailJs</a>
Installation
<h3> This project utilises <a href="https://bun.sh">Bun</a>. Install it before running locally</h3>git clone https://github.com/ShivaBhattacharjee/WasteEasy
cd WasteEasy
cp .env.example .env
bun install
bun dev
This will start the development server at http://localhost:3000/
Host your own
-
Vercel
<br/>
<br/>
-
Netlify
<br/>
<br/>
-
Render
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
-
If you have suggestions for adding or removing projects, feel free to open an issue to discuss it
-
Please make sure you check your spelling and grammar.
Creating A Pull Request
Wanna contribute to WasteEasy ?
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/FeatureName) - Commit your Changes (
git commit -m 'Add some FeatureName') - Push to the Branch (
git push origin feature/FeatureName) - Open a Pull Request
Raising an issue
If you're experiencing any problems with WasteEasy, please be sure to review our issue template before opening a new issue. The template includes a list of questions and prompts that will help us better understand the issue you're experiencing, and it will ensure that we have all of the necessary information to investigate the problem.
We kindly ask that you provide as much detail as possible when submitting an issue, including steps to reproduce the problem, any error messages that you have seen, and any other relevant information. This will help us to identify and fix the issue more quickly.
Thank you for your cooperation, and we look forward to hearing from you!
Code of conduct
Developers are requested to go through our <a href="https://github.com/ShivaBhattacharjee/Trim/blob/WasteEasy/CODE_OF_CONDUCT.md">code of conduct</a> thoroughly to maintain a peaceful environment within our project.
License
Distributed under the Apache License 2.0 . See LICENSE for more information.
Authors
- Shiva Bhattacharjee - Shiva Bhattacharjee - Waste Easy
