From 732df54488f17c314071d2c7a6da85e0daf0e9ca Mon Sep 17 00:00:00 2001 From: Anwin-akz Date: Wed, 31 Jul 2024 21:28:08 +0530 Subject: [PATCH] Update README.md --- README.md | 118 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 117 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d998e65..3279e69 100644 --- a/README.md +++ b/README.md @@ -1 +1,117 @@ -# Waste-Management + +# Waste Management Website (WMW) + +Waste Management Website (WMW) is a comprehensive platform designed to simplify waste management for various stakeholders. The website offers distinct sign-ins for users, employees, and administrators, ensuring tailored access and functionality. It features tools for scheduling bin emptying, marking dumping sites, and managing garbage collection effectively. + +## Features + +- **Separate Sign-Ins**: + - **Users**: For general users to manage their waste disposal needs. + - **Employees**: For staff members to handle day-to-day waste management tasks. + - **Administrators**: For officers to manage the entire system, including user accounts and access levels. + +- **Bin Management**: + - Schedule and track bin emptying to ensure timely garbage removal. + +- **Site Management**: + - Mark and manage designated dumping sites. + +- **Refuse Collection Scheduling**: + - Set up and manage garbage collection schedules for users and businesses. + +## Technologies Used + +- **HTML**: For structuring the website's content. +- **CSS**: For styling and layout. +- **Python**: For backend logic and server-side operations. +- **Databases**: For storing user accounts, schedules, and site data. + +## Installation + +To get a local copy of the project up and running, follow these steps: + +1. **Clone the Repository**: + + ```bash + git clone https://github.com/your-username/waste-management-website.git + ``` + +2. **Navigate to the Project Directory**: + + ```bash + cd waste-management-website + ``` + +3. **Set Up the Virtual Environment** (for Python): + + ```bash + python -m venv venv + ``` + +4. **Activate the Virtual Environment**: + + - On Windows: + + ```bash + venv\Scripts\activate + ``` + + - On macOS/Linux: + + ```bash + source venv/bin/activate + ``` + +5. **Install Dependencies**: + + ```bash + pip install -r requirements.txt + ``` + +6. **Set Up the Database**: + + Follow the instructions in `delivary.db` to initialize and configure the database. + +7. **Run the Application**: + + ```bash + python app3.py + ``` + +## Usage + +- **Users**: + - Sign in to manage your waste disposal preferences. + - Schedule bin emptying and check collection schedules. + +- **Employees**: + - Log in to handle garbage collection and bin management tasks. + +- **Administrators**: + - Access the admin panel to manage user accounts, schedules, and site information. + +## Contributing + +Contributions are welcome! Please adhere to the following guidelines: + +1. Fork the repository. +2. Create a feature branch. +3. Commit your changes. +4. Push to the branch. +5. Open a Pull Request. + +## License + +Distributed under the MIT License. See `LICENSE` for more information. + +## Contact + +For any questions or support, please contact: + +- **Email**: anwinct64@gmail.com +- **Website**: (https://github.com/Anwin-akz/Waste-Management.git) + +--- + +Thank you for using Waste Management Website (WMW)! +