Skip to content

AbdulAHAD968/QUENCH-THIRST

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Quench Thirst

A real-time water-tank monitoring & dispatch platform

License: MIT Open Issues PRs Welcome

Digital logistics and automatic control for municipal water tanks.


Table of Contents

  1. About
  2. Features
  3. Screenshots
  4. Quick Start
  5. Directory Overview
  6. Contributing
  7. License
  8. Contact & Acknowledgements

About

Water shortages are worsening in many Pakistani cities. Households often rely on private tankers booked by phone and logged in paper registers. The process is slow, opaque and error-prone.

Quench Thirst replaces manual ledgers with a real-time web system that:

  • measures tank levels with IoT sensors
  • auto-dispatches tanker routes through an Express API
  • gives residents and municipal teams a live dashboard

The stack is familiar—Node.js  |  Express  |  MongoDB  |  React—so local devs can extend it without steep learning curves.


Features

  • Live tank-level charts with 5-second polling
  • Automatic SMS / WhatsApp alerts when levels fall below a threshold
  • One-click tanker dispatch; optimal routes via Google Maps API
  • Role-based access (Resident, Driver, Admin)
  • Audit log of deliveries and complaints
  • PWA install for offline-first field use
  • UI inspired by Google Keep—clean panels, soft shadows

Repository Overview


Gallery

View Preview
Login Page Quench Thirst login
Admin Dashboard Admin Dashboard
User Dashboard User Dashboard
Employee Dashboard Employee Dashboard
Sales Tracking Quench Thirst login
Order Management Quench Thirst login

(PNG assets live under ./assets/)


Quick Start

Prerequisites

Tool Version
Node.js ≥ 18 LTS
MongoDB ≥ 6.0
Yarn ≥ 1.22

Installation

git clone https://github.com/your-org/quench-thirst.git
cd quench-thirst
cp .env.example .env        # add your keys
yarn && yarn bootstrap      # install root + workspace deps

Contributing

Fork ➜ Create branch ➜ Commit ➜ Pull request
  • Follow the ESLint/Prettier rules (yarn lint --fix).
  • Small, focused PRs are easier to review. Questions? Open a draft PR early.

License

Distributed under the MIT License. See LICENSE for details.


Contact & Acknowledgements

Maintainers:

  • Abdul Ahad · @AbdulAHAD968
  • Team Quench Thirst, Islamabad

About

Developed a full-fledged water delivery management platform with separate interfaces for users, employees, and admins. Mimicking Real-time order tracking, user authentication, and dashboard analytics.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors