Skip to content

Commit

Permalink
Merge branch 'main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
royvivi29 authored Oct 25, 2024
2 parents 47f9c4f + 7880a0f commit 1e3b2d2
Show file tree
Hide file tree
Showing 25 changed files with 3,944 additions and 417 deletions.
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"liveServer.settings.port": 5502
"liveServer.settings.port": 5503
}
121 changes: 114 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,122 @@

<div align="center">
<h1> Waste Management</h1>
</div>

This platform is designed to empower users in managing waste efficiently and contributing to a cleaner, greener planet. It offers features such as image uploads for waste classification, disposal guidelines, real-time monitoring, eco-friendly tips, and opportunities for community engagement.

**Discord Link**: [Join our Community](https://discord.gg/JP43BDWP)

---

## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

---

## Features

This platform is designed to empower users in managing waste efficiently and contributing to a cleaner, greener planet. It offers features such as image uploads for waste classification, disposal guidelines, real-time monitoring, eco-friendly tips, and opportunities for community engagement
- **Image Uploads for Waste Classification**: Users can upload images of waste, and the platform will classify them using machine learning.
- **Disposal Guidelines**: Provides instructions on how to properly dispose of various types of waste.
- **Real-Time Monitoring**: Allows users to track their waste disposal habits and provides insights to reduce waste.
- **Eco-Friendly Tips**: Offers practical tips for adopting a greener lifestyle.
- **Community Engagement**: Users can join a community to discuss sustainability and eco-friendly practices.

**Discord Link:-** https://discord.gg/JP43BDWP
---

## Technologies used:
## Technologies Used

- **Backend**: Python, Flask (for waste classification and backend processing).
- **Frontend**: HTML5, CSS3, JavaScript (for UI/UX).
- **Machine Learning**: TensorFlow, Scikit-learn (for waste classification).
- **Database**: SQLite (for storing user data and classification results).

<img src="https://img.shields.io/badge/html5%20-%23E34F26.svg?&style=for-the-badge&logo=html5&logoColor=white"/> <img src="https://img.shields.io/badge/css3%20-%231572B6.svg?&style=for-the-badge&logo=css3&logoColor=white"/> <img src="https://img.shields.io/badge/javascript%20-%23323330.svg?&style=for-the-badge&logo=javascript&logoColor=%23F7DF1E"/>

---

<hr>
## Installation

1. Clone the repository:

```bash
git clone https://github.com/yourusername/WasteManagment.git
cd WasteManagment
```

2. Install required dependencies:

```bash
pip install -r requirements.txt
```

3. Run the application:

```bash
python app.py
```

4. Open a browser and go to `http://127.0.0.1:5000/` to access the application.

---

## Usage

1. **Upload Waste Image**: Upload an image of waste, and the platform will classify it as recyclable, non-recyclable, or compostable.
2. **View Disposal Guidelines**: Follow the guidelines provided for proper waste management.
3. **Track Waste**: Use the dashboard to monitor waste habits.
4. **Explore Eco Tips**: Browse eco-friendly tips to reduce your carbon footprint.

---

## Contributing

We welcome contributions to enhance the platform!

<div>
<h2><img src="https://fonts.gstatic.com/s/e/notoemoji/latest/2728/512.webp" width="35" height="35"> Ready to Contribute?</h2>
</div>

If you would like to contribute to the project, please follow our contribution guidelines.
Here’s a more detailed version of the "Steps for Contributing" section:




### How to Contribute:
1. Fork the repository.
2. Create a new branch for your feature/bug fix:
```bash
git checkout -b feature-branch
```
3. Make your changes and commit them:
```bash
git commit -m "Add new feature"
```
4. Push your changes to the remote repository:
```bash
git push origin feature-branch
```
5. Submit a pull request.

For more details on contributing, refer to the `CONTRIBUTING.md` file.

---

### Color Palette 🎨

The color palette used in the Waste Management website is fixed to ensure a consistent and appealing design. Below are the primary colors used:

- **Teal**: ![#006D77](https://via.placeholder.com/15/006D77/000000?text=+) `#006D77`
- **Light Teal**: ![#83C5BE](https://via.placeholder.com/15/83C5BE/000000?text=+) `#83C5BE`
- **Light Blue**: ![#EDF6F9](https://via.placeholder.com/15/EDF6F9/000000?text=+) `#EDF6F9`
- **Light BlueGreen**: ![#EDF6F9](https://via.placeholder.com/15/EDF6F9/000000?text=+) `#EDF6F9`
- **Peach**: ![#FFDDD2](https://via.placeholder.com/15/FFDDD2/000000?text=+) `#FFDDD2`
- **Coral**: ![#E29578](https://via.placeholder.com/15/E29578/000000?text=+) `#E29578`

**Important**: Please use this color palette exclusively for all design elements in the project.

**Reference**: [Coolors.co Palette](https://coolors.co/palette/006d77-83c5be-edf6f9-ffddd2-e29578)
Expand Down Expand Up @@ -54,7 +148,7 @@ Here’s a more detailed version of the "Steps for Contributing" section:
</tr>
<tr>
<td>
This project is part of GirlScript Summer of Code. We enthusiastically invite community contributions to contribute to Community-Site.
This project is part of GirlScript Summer of Code. We enthusiastically invite community contributions to contribute to Waste Managment.
</td>
</tr>
</table>
Expand All @@ -73,3 +167,16 @@ Please note that this project is released with a [Contributor Code of Conduct](C
### License 📝

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

### Open Source Programs

<img src="https://girlscriptsummerofcode.github.io/MentorshipProgram/images/gssoc.png" alt="GSSOC Logo" width="100px">
This project is part of GirlScript Summer of Code. We enthusiastically invite community contributions to contribute to this project.

### Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.

---
Binary file added assets/6824802.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/6881999.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/landfill.avif
Binary file not shown.
Binary file added assets/organic.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/papercup.avif
Binary file not shown.
Binary file added assets/pbottle.avif
Binary file not shown.
Binary file added assets/peel.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/rb_2148298503.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/rb_8795.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/rbin.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added bot.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added chatbot.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 1e3b2d2

Please sign in to comment.