OWM — Optimised Waste Management System ♻️

Introduction

OWM is an optimised waste management system designed to streamline and automate waste‑collection workflows, enabling efficient scheduling, tracking, and handling of waste management tasks. The project is built using Python and supports containerised deployment (Docker), making it easy to run in different environments.

Table of Contents

• Features
• Architecture & Project Structure
• Installation
• Usage
• Configuration & Environment Setup
• Dependencies
• Contributing
• Troubleshooting
• License

Features

• Core backend implemented in Python.
• Containerized deployment via Docker and docker‑compose.
• Modular project structure separating jobs, routes, and main application logic.
• client.py — client/interface script.
• Build and deployment scripts (build.sh, Dockerfile) to support CI/CD or quick local deployment.

Architecture & Project Structure

owm/
├── jobs/
├── routes/
├── client.py
├── main.py
├── Dockerfile
├── docker-compose.yml
├── build.sh
├── requirements.txt
├── runtime.txt
└── .gitignore

Installation

Prerequisites

• Docker and Docker Compose.
• Optional: Python 3.x for local (non‑Docker) execution.

Steps

git clone https://github.com/adithya1770/owm.git
cd owm
chmod +x build.sh
docker-compose up --build

Usage

• Interact with backend routes defined in routes/.
• Use client.py if configured.
• For production, use Docker Compose.

Configuration & Environment Setup

• Configure environment variables as needed.
• Install Python dependencies via:

pip install -r requirements.txt

Dependencies

• Python (version defined in runtime.txt)
• Python packages in requirements.txt
• Docker & Docker Compose

Contributing

1. Fork repo
2. Create branch:

git checkout -b feature/YourFeature

3. Commit & make PR.

Troubleshooting

Issue	Solution
Docker build fails	Check Docker daemon and Dockerfile.
App crashes	Verify env variables & dependencies.
API unreachable	Check port mapping & routes.

License

Add a LICENSE file if applicable.