Skip to content

README.md

Latest commit

 

History

History
108 lines (74 loc) · 1.88 KB

README.md

File metadata and controls

108 lines (74 loc) · 1.88 KB
Raw

♻️ Waste Management System API

A scalable backend API powering a smart waste management platform. The system enables residents to schedule waste collection, report illegal dumping, manage recycling requests, and supports waste collectors with efficient collection management.

The project is designed using a modular service-based architecture, making it easy to maintain and extend as the platform grows.

🚀 Features

  • User Authentication & Authorization
  • Waste Collection Request Management
  • Illegal Dump Reporting
  • Recycling Request Management
  • Collector Management
  • Reward System
  • Cloud Image Upload Support
  • RESTful API Architecture

🛠 Tech Stack

  • Node.js
  • Express.js
  • MongoDB
  • Mongoose
  • JWT Authentication
  • Cloudinary
  • Nodemailer

📂 Project Structure

src/
├── controller/
├── middleware/
├── model/
├── routes/
├── services/
├── app.js
└── index.js

📌 Core Modules

  • Authentication
  • User Management
  • Waste Collection
  • Recycling
  • Illegal Dump Reporting
  • Collector Operations
  • Email Notifications

🚀 Installation

git clone <repository-url>

npm install

npm run dev

🔐 Environment Variables

Create a .env file containing:

  • MongoDB URI
  • JWT Secret
  • Cloudinary Credentials
  • Email Credentials
  • Port

🌟 Why I Built This

This project was developed to simplify waste management operations by providing a centralized platform where residents can request waste collection, report environmental issues, and encourage recycling through digital services.

🔮 Future Improvements

  • Real-time notifications
  • GPS tracking for collectors
  • Payment integration
  • Analytics dashboard
  • Push notifications
  • Automated scheduling

👨‍💻 Author

Temmy (Tembogs)

Full-Stack Software Engineer

GitHub: https://github.com/Tembogs