Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Anwin-akz authored Jul 31, 2024
1 parent 688be90 commit 732df54
Showing 1 changed file with 117 additions and 1 deletion.
118 changes: 117 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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**: [email protected]
- **Website**: (https://github.com/Anwin-akz/Waste-Management.git)

---

Thank you for using Waste Management Website (WMW)!

0 comments on commit 732df54

Please sign in to comment.