Skip to content

Commit

Permalink
Update README.md (#232)
Browse files Browse the repository at this point in the history
<!-- Thank you for sending a pull request ❤️ -->

## Issues Identification

Closes: #(230)

## Description

### Summary
added table of contents and how to contribute in readme.md

### Details
added table of contents and how to contribute in readme.md

## Types of Changes

_Please check the boxes that apply_

- [ ] Bugfix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] Documentation update (Documentation content changed)
- [ ] Other (please describe):

## Checklist

_Please check the boxes that apply_

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] My changes do not break the current system and pass all existing
test cases
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream
modules

## Screenshots

If applicable, please attach screenshots of the changes made to the user
interface.

## Additional Information

Please provide any other information that is relevant to this pull
request.

<!-- We're looking forward to merging your contribution!! -->
  • Loading branch information
GarimaSingh0109 authored Oct 21, 2024
2 parents aad9762 + 23cf7dd commit 81dd994
Showing 1 changed file with 115 additions and 45 deletions.
160 changes: 115 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,145 @@

<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

- **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.

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:-** 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"/>

---

## 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:

<hr>
```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)


<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:

### Steps for Contributing
**For steps on how to contribute refer to CONTRIBUTING.md**
<hr>
<!-- Open Source Programs -->
<div>
<h2><img src="https://github.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/blob/master/Emojis/Hand%20gestures/Flexed%20Biceps.png?raw=true" width="35" height="35" > Open Source Programs</h2>
</div>

<table border="1" cellpadding="10">
<tr>
<td rowspan="2">
<img src="https://github.com/Its-Aman-Yadav/Community-Site/assets/133582566/d3bf4882-8e12-40ea-b300-af4e3cfc5545" alt="GSSOC Logo" width="100" height="55">
</td>
<td>
<strong>GSSOC 2024</strong>
</td>
</tr>
<tr>
<td>
This project is part of GirlScript Summer of Code. We enthusiastically invite community contributions to contribute to Community-Site.
</td>
</tr>
</table>

<hr>

<!-- Code of conduct -->
<div>
<h2><img src = "https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand%20gestures/Handshake.png" width="35" height="35"> Code of Conduct</h2>
</div>

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.

<hr>
---

### License 📝
## 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.

---

0 comments on commit 81dd994

Please sign in to comment.