# prawshant123-ui/safa-city architecture

> Architecture diagram of the GitHub repository prawshant123-ui/safa-city, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/prawshant123-ui/safa-city
- Repository: https://github.com/prawshant123-ui/safa-city

## Overview

SafaCity is a municipal waste-management platform: citizens submit and follow reports, administrators oversee bins and analytics and assign work, and collectors manage assigned tasks. The React SPA serves role-specific workflows and calls an Express REST API; backend controllers use Prisma for persistence, with Cloudinary for report media. The README also describes live vehicle tracking, though the sampled source does not establish its runtime data path. Several domain pages and routes were not sampled, so their connections are limited to documented or indexed evidence.

Main entry points: [`Frontend/src/App.jsx`](https://github.com/prawshant123-ui/safa-city/blob/main/Frontend/src/App.jsx) (React application), [`Backend/src/config/prisma.js`](https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/config/prisma.js) (Prisma client), [`Frontend/src/api`](https://github.com/prawshant123-ui/safa-city/tree/main/Frontend/src/api) (API client), [`Frontend/src/pages/admin`](https://github.com/prawshant123-ui/safa-city/tree/main/Frontend/src/pages/admin) (Admin operations)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Role-based client"]
  node_spa["React application<br/>[App.jsx]"]
  node_auth_state["Auth state<br/>[AuthContext.jsx]"]
  node_citizen_reports["Citizen reports"]
  node_admin_console["Admin operations"]
  node_collector_tasks["Collector tasks"]
  node_map_views["Bin and map views<br/>[BinMap.jsx]"]
  node_api_client["API client"]
  node_leaflet["Leaflet map"]
end

subgraph group_api["Backend API"]
  node_express_api["Express API<br/>[app.js]"]
  node_auth_routes["Auth routes<br/>[authRoute.js]"]
  node_domain_routes["Domain routes"]
  node_auth_logic["Authentication<br/>[authController.js]"]
  node_domain_logic["Domain controllers"]
  node_access_control["Access control"]
end

subgraph group_ops["Waste operations"]
  node_dashboard_logic["Dashboard analytics"]
  node_collection_logic["Collection dispatch"]
  node_vehicle_logic["Vehicle management"]
end

subgraph group_infra["Persistence and media"]
  node_prisma["Prisma client<br/>[prisma.js]"]
  node_postgres[("PostgreSQL")]
  node_media_upload["Media upload"]
  node_cloudinary["Cloudinary"]
end

node_citizens(("Citizens"))
node_administrators(("Administrators"))
node_collectors(("Collectors"))

node_citizens -->|"use"| node_spa
node_administrators -->|"use"| node_spa
node_collectors -->|"use"| node_spa
node_spa -->|"reads auth"| node_auth_state
node_spa -->|"routes to"| node_citizen_reports
node_spa -->|"routes to"| node_admin_console
node_spa -->|"routes to"| node_collector_tasks
node_citizen_reports -->|"requests data"| node_api_client
node_admin_console -->|"requests analytics"| node_api_client
node_collector_tasks -->|"loads tasks"| node_api_client
node_api_client -->|"calls REST API"| node_express_api
node_express_api -->|"mounts"| node_auth_routes
node_express_api -->|"mounts"| node_domain_routes
node_auth_routes -->|"dispatches"| node_auth_logic
node_domain_routes -.->|"dispatches"| node_domain_logic
node_domain_logic -->|"queries"| node_prisma
node_dashboard_logic -->|"queries"| node_prisma
node_collection_logic -->|"queries"| node_prisma
node_vehicle_logic -->|"queries"| node_prisma
node_prisma -->|"accesses"| node_postgres
node_collection_logic -->|"uploads media"| node_media_upload
node_media_upload -->|"stores media"| node_cloudinary
node_admin_console -->|"renders hotspots"| node_map_views
node_map_views -->|"renders map"| node_leaflet
node_administrators -.->|"manage vehicles"| node_vehicle_logic
node_collectors -.->|"complete assignments"| node_collection_logic

click node_spa "https://github.com/prawshant123-ui/safa-city/blob/main/Frontend/src/App.jsx"
click node_auth_state "https://github.com/prawshant123-ui/safa-city/blob/main/Frontend/src/context/AuthContext.jsx"
click node_citizen_reports "https://github.com/prawshant123-ui/safa-city/tree/main/Frontend/src/pages/citizen"
click node_admin_console "https://github.com/prawshant123-ui/safa-city/tree/main/Frontend/src/pages/admin"
click node_collector_tasks "https://github.com/prawshant123-ui/safa-city/tree/main/Frontend/src/pages/collector"
click node_map_views "https://github.com/prawshant123-ui/safa-city/blob/main/Frontend/src/components/map/BinMap.jsx"
click node_api_client "https://github.com/prawshant123-ui/safa-city/tree/main/Frontend/src/api"
click node_express_api "https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/app.js"
click node_auth_routes "https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/routes/authRoute.js"
click node_domain_routes "https://github.com/prawshant123-ui/safa-city/tree/main/Backend/src/routes"
click node_auth_logic "https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/controllers/authController.js"
click node_domain_logic "https://github.com/prawshant123-ui/safa-city/tree/main/Backend/src/controllers"
click node_access_control "https://github.com/prawshant123-ui/safa-city/tree/main/Backend/src/middlewares"
click node_dashboard_logic "https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/controllers/dashboardController.js"
click node_collection_logic "https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/controllers/collectionController.js"
click node_vehicle_logic "https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/controllers/vehicleController.js"
click node_prisma "https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/config/prisma.js"
click node_media_upload "https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/utils/cloudinaryUpload.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_spa,node_auth_state,node_citizen_reports,node_admin_console,node_collector_tasks,node_map_views,node_api_client,node_leaflet toneBlue
class node_express_api,node_auth_routes,node_domain_routes,node_auth_logic,node_domain_logic,node_access_control toneAmber
class node_dashboard_logic,node_collection_logic,node_vehicle_logic toneMint
class node_prisma,node_postgres,node_media_upload,node_cloudinary toneRose
class node_citizens,node_administrators,node_collectors toneIndigo
```

## Components

### Role-based client

- [React application](https://github.com/prawshant123-ui/safa-city/blob/main/Frontend/src/App.jsx): `Frontend/src/App.jsx`
- [Auth state](https://github.com/prawshant123-ui/safa-city/blob/main/Frontend/src/context/AuthContext.jsx): `Frontend/src/context/AuthContext.jsx`
- [Citizen reports](https://github.com/prawshant123-ui/safa-city/tree/main/Frontend/src/pages/citizen): `Frontend/src/pages/citizen`
- [Admin operations](https://github.com/prawshant123-ui/safa-city/tree/main/Frontend/src/pages/admin): `Frontend/src/pages/admin`
- [Collector tasks](https://github.com/prawshant123-ui/safa-city/tree/main/Frontend/src/pages/collector): `Frontend/src/pages/collector`
- [Bin and map views](https://github.com/prawshant123-ui/safa-city/blob/main/Frontend/src/components/map/BinMap.jsx): `Frontend/src/components/map/BinMap.jsx`
- [API client](https://github.com/prawshant123-ui/safa-city/tree/main/Frontend/src/api): `Frontend/src/api`
- **Leaflet map**

### Backend API

- [Express API](https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/app.js): `Backend/src/app.js`
- [Auth routes](https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/routes/authRoute.js): `Backend/src/routes/authRoute.js`
- [Domain routes](https://github.com/prawshant123-ui/safa-city/tree/main/Backend/src/routes): `Backend/src/routes`
- [Authentication](https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/controllers/authController.js): `Backend/src/controllers/authController.js`
- [Domain controllers](https://github.com/prawshant123-ui/safa-city/tree/main/Backend/src/controllers): `Backend/src/controllers`
- [Access control](https://github.com/prawshant123-ui/safa-city/tree/main/Backend/src/middlewares): `Backend/src/middlewares`

### Waste operations

- [Dashboard analytics](https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/controllers/dashboardController.js): `Backend/src/controllers/dashboardController.js`
- [Collection dispatch](https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/controllers/collectionController.js): `Backend/src/controllers/collectionController.js`
- [Vehicle management](https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/controllers/vehicleController.js): `Backend/src/controllers/vehicleController.js`

### Persistence and media

- [Prisma client](https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/config/prisma.js): `Backend/src/config/prisma.js`
- **PostgreSQL**
- [Media upload](https://github.com/prawshant123-ui/safa-city/blob/main/Backend/src/utils/cloudinaryUpload.js): `Backend/src/utils/cloudinaryUpload.js`
- **Cloudinary**

### Other components

- **Citizens**
- **Administrators**
- **Collectors**

## Connections

- Citizens → React application: use
- Administrators → React application: use
- Collectors → React application: use
- React application → Auth state: reads auth (evidence: `Frontend/src/App.jsx`)
- React application → Citizen reports: routes to (evidence: `Frontend/src/App.jsx`)
- React application → Admin operations: routes to (evidence: `Frontend/src/App.jsx`)
- React application → Collector tasks: routes to (evidence: `Frontend/src/App.jsx`)
- Citizen reports → API client: requests data (evidence: `Frontend/src/pages/citizen/CitizenDashboard.jsx`)
- Admin operations → API client: requests analytics (evidence: `Frontend/src/pages/admin/AdminDashboard.jsx`)
- Collector tasks → API client: loads tasks (evidence: `Frontend/src/pages/collector/MyTasks.jsx`)
- API client → Express API: calls REST API
- Express API → Auth routes: mounts (evidence: `Backend/src/app.js`)
- Express API → Domain routes: mounts (evidence: `Backend/src/app.js`)
- Auth routes → Authentication: dispatches (evidence: `Backend/src/routes/authRoute.js`)
- Domain routes → Domain controllers: dispatches (evidence: `Backend/src/routes/authRoute.js`)
- Domain controllers → Prisma client: queries (evidence: `Backend/src/controllers/binController.js`)
- Dashboard analytics → Prisma client: queries (evidence: `Backend/src/controllers/dashboardController.js`)
- Collection dispatch → Prisma client: queries (evidence: `Backend/src/controllers/collectionController.js`)
- Vehicle management → Prisma client: queries (evidence: `Backend/src/controllers/vehicleController.js`)
- Prisma client → PostgreSQL: accesses
- Collection dispatch → Media upload: uploads media (evidence: `Backend/src/controllers/collectionController.js`)
- Media upload → Cloudinary: stores media
- Admin operations → Bin and map views: renders hotspots (evidence: `Frontend/src/pages/admin/AdminDashboard.jsx`)
- Bin and map views → Leaflet map: renders map
- Administrators → Vehicle management: manage vehicles
- Collectors → Collection dispatch: complete assignments
