How harlestnguyen/traffic-congestion-alert-application works
Project Type and Purpose
• This is a full-stack mobile application for traffic jam alerts, composed of:
• An Android client (“DoAnNganh/app”)
• A RESTful API server in ASP.NET Core (“ApiDoAn/ApiDoAn”)
• A SQL Server database (backup files in root)
• Users register/login, send warnings with geocoordinates, admins moderate.
File Structure Analysis
• Server (“ApiDoAn/ApiDoAn”):
• Controllers (AddressController, WarningController, UserController, AdminController) → MVC pattern
• Models (LoginModel, RegisterModel, WarningModel, AddressModel, etc.)
• Program.cs + launchSettings.json + appsettings.json → hosting & config (JWT Issuer, SQL connection string)
• Client (“DoAnNganh/app”):
• Activities (LoginActivity, MainActivity, WarningNearbyActivity, Admin and User flows) → UI layer
• Object (API.java, Warning.java, User.java, Address.java, StaticClass) → data models & constants
• Repository (WarningRepository, UserRepository, AddressRepository, MapRepository) → data layer, network calls
• Gradle config + Android resources (layouts, drawables, menus)
README Insights
• API uses JWT authentication and exposes endpoints via Swagger.
• Database is SQL Server; backup and .sql scripts provided.
• Android app points to IPv4:port; calls API endpoints from API.java.
Main Components & Interactions
• Android Client
• UI layer (Activities)
• Repository layer issues HTTP requests to API
• Local models map JSON ↔ Java objects
• RESTful API Server
• Controllers handle requests, validate JWT, call service/repository logic
• Entity Framework (implied) interacts with SQL Server
• SQL Server Database
• Tables for Users, Roles, Addresses, Warnings
• External/Infrastructure
• JWT Issuer/Authority (self-hosted ASP.NET Core)
• Network over HTTP (Swagger UI for testing)
Architectural Patterns & Design Principles
• Server: MVC, layered (Controllers → Services/Repositories → Data)
• Client: MVVM-style separation (Activities ← Repositories ← Network/API)
• Use of Repository pattern to abstract data access
• Stateless REST, JWT for authentication/authorization
• Clear separation of concerns: UI, business logic, data