Waba Yangu (meaning "My Water" in Swahili) is a comprehensive IoT-enabled digital monitoring system designed to help users track, manage, and optimize their water consumption. The platform combines hardware (ESP8266-based firmware), a Django REST API backend, and a React-based frontend to provide real-time monitoring and control of water usage, with integrated M-Pesa payment functionality for utility billing.
- Real-time Monitoring: Track your water consumption in real-time through IoT devices
- User Authentication & Management: Secure user registration, login, and profile management with JWT authentication
- Subscription Plans: Free, Basic, and Premium subscription tiers
- M-Pesa Integration: Seamless payment integration using Safaricom's M-Pesa STK Push
- Cloud Storage: Profile picture management via Cloudinary
- RESTful API: Well-structured Django REST Framework backend
- Modern Frontend: React-based single-page application with Vite
- IoT Firmware: ESP8266-based firmware for water monitoring devices
- Framework: Django 5.2.1
- API: Django REST Framework 3.16.0
- Authentication: JWT (djangorestframework-simplejwt 5.5.0)
- Database: PostgreSQL (psycopg2 2.9.10)
- Cloud Storage: Cloudinary 1.44.0
- Payment Integration: Africa's Talking 1.2.9
- Time Series Data: InfluxDB 5.3.2
- API Documentation: drf-yasg 1.21.10
- Messaging: MQTT (paho-mqtt 2.1.0)
- Framework: React 19.1.0
- Build Tool: Vite 6.3.5
- Language: JavaScript (ES6+)
- Linting: ESLint 9.25.0
- Platform: ESP8266 (ESP-12E module)
- Framework: Arduino
- IDE: PlatformIO
- Libraries: ArduinoJson 7.0.3, MpesaSTK
- Python 3.11+
- PostgreSQL 12+
- pip (Python package manager)
- Node.js 18+
- npm or yarn
- PlatformIO IDE or CLI
- ESP8266 development board
git clone https://github.com/manassehgitau/Waba-Yangu-WebApp.git
cd Waba-Yangu-WebAppcd waba-backend
# Create a virtual environment
python -m venv venv
# Activate virtual environment
# On Linux/Mac:
source venv/bin/activate
# On Windows:
venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
# Copy .env.example to .env and configure your environment variables
cp .env.example .env
# Edit .env with your actual configuration values
# Run migrations
python manage.py migrate
# Create a superuser
python manage.py createsuperuser
# Run the development server
python manage.py runserverThe backend API will be available at http://localhost:8000
cd waba-frontend
# Install dependencies
npm install
# Copy .env.example to .env and configure your environment variables
cp .env.example .env
# Edit .env with your actual configuration values
# Run the development server
npm run devThe frontend will be available at http://localhost:5173
cd Waba-Yangu-Firmware
# Install PlatformIO if you haven't already
# Using pip:
pip install platformio
# Update WiFi credentials and M-Pesa keys in src/main.cpp
# Then build and upload to your ESP8266 device
pio run --target upload
# Monitor serial output
pio device monitorcd waba-backend
# Build the Docker image
docker build -t waba-backend .
# Run the container
docker run -p 8000:8000 -e DATABASE_URL=your-db-url waba-backendOnce the backend is running, you can access the interactive API documentation:
- Swagger UI:
http://localhost:8000/swagger/ - ReDoc:
http://localhost:8000/redoc/
POST /api/auth/register/- User registrationPOST /api/auth/login/- User login (JWT tokens)GET /api/users/me/- Get current user profilePUT /api/users/me/- Update user profileDELETE /api/users/me/- Delete user accountPOST /api/auth/change-password/- Change passwordPOST /api/auth/forgot-password/- Request password resetPOST /api/auth/reset-password/- Reset password with token
cd waba-backend
# Run migrations after model changes
python manage.py makemigrations
python manage.py migrate
# Create a new Django app
python manage.py startapp app_name
# Run tests (when available)
python manage.py test
# Collect static files for production
python manage.py collectstaticcd waba-frontend
# Lint code
npm run lint
# Build for production
npm run build
# Preview production build
npm run previewcd Waba-Yangu-Firmware
# Build firmware
pio run
# Upload to device
pio run --target upload
# Clean build files
pio run --target cleanEach component requires environment configuration. Example files are provided:
- Backend: See
waba-backend/.env.examplefor all required backend environment variables - Frontend: See
waba-frontend/.env.examplefor frontend configuration
Copy the respective .env.example file to .env in each directory and update with your actual values.
The platform supports three subscription tiers:
- Free: Basic monitoring features
- Basic: Enhanced monitoring and analytics
- Premium: Full feature access with advanced analytics and priority support
Contributions are welcome! Please follow these steps:
- Fork the repository
- Create a feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
- Backend: Follow PEP 8 style guidelines for Python
- Frontend: Use ESLint configuration provided in the project
- Firmware: Follow Arduino/C++ best practices
This project is licensed under the MIT License - see the LICENSE file for details.
- Manasseh Gitau - manassehgitau
- Safaricom M-Pesa API for payment integration
- Cloudinary for media storage
- Django and React communities for excellent documentation
- PlatformIO for IoT development tools
For support, email support@wabayangu.com or open an issue in the GitHub repository.
- Add real-time energy consumption graphs
- Implement device management dashboard
- Add push notifications for alerts
- Expand payment options beyond M-Pesa
- Add mobile applications (iOS/Android)
- Implement advanced analytics and reporting
- Add multi-language support
Made with ❤️ in Kenya