Overview
Urban Management is a comprehensive urban management platform that provides two specialized APIs:- Primary Backend (Port 3001): Administrative operations, web dashboards, and comprehensive management features
- Mobile Backend (Port 3002): Mobile applications with phone-based authentication and citizen services
Quick Start
Primary Backend
Administrative API with cookie-based authentication and role-based permissions for comprehensive urban management.
Mobile Backend
Mobile-first API with phone-based OTP authentication optimized for citizen services.
Core Features
Primary Backend
- User Management: Complete CRUD operations for citizens and residents
- Admin Management: Administrative user management with role-based access
- Building Management: Hierarchical management of sectors, buildings, floors, units, and blocks
- Ticket System: Comprehensive support ticket management with technician assignment
- Permission System: Granular role-based access control with customizable permissions
- File Management: Secure image upload and document management
- Address Management: Geographic and address data management
- Vehicle Management: Vehicle registration and tracking
- Family Management: Family member associations and management
Mobile Backend
- Phone Authentication: Secure OTP-based authentication system
- User Profiles: Mobile-optimized user profile management
- Citizen Services: Mobile-first citizen service endpoints
- Optimized Responses: Lightweight, mobile-optimized API responses
API Architecture
Both backends follow RESTful principles with:- Consistent Response Format: Standardized success/error response structure
- Authentication: Secure authentication mechanisms tailored to each use case
- Validation: Comprehensive input validation using Zod schemas
- Rate Limiting: Configurable rate limiting for API protection
- Error Handling: Detailed error responses with proper HTTP status codes
Getting Started
- Setup: Follow the Setup Guide to get your development environment ready
- Authentication: Understand the Authentication Flow for each backend
- Integration: Review the Integration Guide for implementation details
- API Patterns: Learn about API Patterns and best practices