# sandesh339/ums architecture

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

- Interactive diagram: https://gitdiagram.com/sandesh339/ums
- Repository: https://github.com/sandesh339/ums

## Overview

This Django-based Utility Management System serves a campus map of geographic assets and lets users register and manage utility complaints. The main user path is map access through utility views and read APIs; authenticated users can submit geolocated complaints, while administrators can mark them resolved. User registration, activation, and password recovery are a separate identity flow. Geographic layers can also be loaded from shapefiles. The source index and excerpts support the server-side links shown; the map JavaScript’s API interactions were not established by the supplied evidence.

Main entry points: [`utilities/viewset.py`](https://github.com/sandesh339/ums/blob/master/utilities/viewset.py) (Complaint Handling), [`user/viewset.py`](https://github.com/sandesh339/ums/blob/master/user/viewset.py) (Account Workflows), [`utilities/urls.py`](https://github.com/sandesh339/ums/blob/master/utilities/urls.py) (Utility Routes), [`utilities/models.py`](https://github.com/sandesh339/ums/blob/master/utilities/models.py) (Campus Asset Data)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_identity["Identity and Access"]
  node_user_routes["User Routes<br/>[urls.py]"]
  node_user_handlers["Account Workflows<br/>[viewset.py]"]
  node_user_serializer["User Serializer<br/>[serializers.py]"]
  node_user_model[("User Account<br/>[models.py]")]
end

subgraph group_mapping["Campus Mapping"]
  node_utility_routes["Utility Routes<br/>[urls.py]"]
  node_map_handlers["Map and Asset APIs<br/>[viewset.py]"]
  node_map_pages["Map Pages"]
  node_map_client["Map Client"]
  node_geo_serializers["Geo Serializers<br/>[serializers.py]"]
  node_asset_models[("Campus Asset Data<br/>[models.py]")]
end

subgraph group_complaints["Utility Complaints"]
  node_complaint_flow["Complaint Handling<br/>[viewset.py]"]
  node_complaint_model[("Complaint Records<br/>[models.py]")]
end

subgraph group_ingestion["Geospatial Ingestion"]
  node_load_command["Load Command<br/>[uploaddata.py]"]
  node_layer_loader["Shapefile Loader<br/>[load.py]"]
end

node_visitor(("Visitor or User"))
node_administrator(("Administrator"))
node_email_service["Email Service"]
node_postgres[("PostgreSQL Database")]

node_visitor -->|"opens account routes"| node_user_routes
node_user_routes -->|"routes requests"| node_user_handlers
node_user_handlers -->|"validates registration"| node_user_serializer
node_user_handlers -->|"reads and saves"| node_user_model
node_user_handlers -->|"sends account email"| node_email_service
node_visitor -->|"opens utility pages"| node_utility_routes
node_utility_routes -->|"routes requests"| node_map_handlers
node_map_handlers -->|"renders pages"| node_map_pages
node_map_handlers -->|"serializes asset data"| node_geo_serializers
node_map_handlers -->|"queries assets"| node_asset_models
node_visitor -.->|"uses map interface"| node_utility_routes
node_administrator -.->|"manages complaints"| node_utility_routes
node_complaint_flow -->|"creates and updates"| node_complaint_model
node_complaint_flow -->|"checks boundary"| node_asset_models
node_complaint_flow -->|"validates complaint data"| node_geo_serializers
node_complaint_flow -->|"emails resolution"| node_email_service
node_load_command -->|"runs layer imports"| node_layer_loader
node_layer_loader -->|"loads geographic layers"| node_asset_models
node_asset_models -->|"persists geographic records"| node_postgres
node_complaint_model -->|"persists complaints"| node_postgres
node_user_model -->|"persists accounts"| node_postgres

click node_user_routes "https://github.com/sandesh339/ums/blob/master/user/urls.py"
click node_user_handlers "https://github.com/sandesh339/ums/blob/master/user/viewset.py"
click node_user_serializer "https://github.com/sandesh339/ums/blob/master/user/serializers.py"
click node_user_model "https://github.com/sandesh339/ums/blob/master/user/models.py"
click node_utility_routes "https://github.com/sandesh339/ums/blob/master/utilities/urls.py"
click node_map_handlers "https://github.com/sandesh339/ums/blob/master/utilities/viewset.py"
click node_map_pages "https://github.com/sandesh339/ums/tree/master/utilities/templates/utilities"
click node_map_client "https://github.com/sandesh339/ums/tree/master/utilities/static/utilities/js"
click node_geo_serializers "https://github.com/sandesh339/ums/blob/master/utilities/serializers.py"
click node_asset_models "https://github.com/sandesh339/ums/blob/master/utilities/models.py"
click node_complaint_flow "https://github.com/sandesh339/ums/blob/master/utilities/viewset.py"
click node_complaint_model "https://github.com/sandesh339/ums/blob/master/utilities/models.py"
click node_load_command "https://github.com/sandesh339/ums/blob/master/utilities/management/commands/uploaddata.py"
click node_layer_loader "https://github.com/sandesh339/ums/blob/master/utilities/load.py"

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_user_routes,node_user_handlers,node_user_serializer,node_user_model,node_visitor toneBlue
class node_utility_routes,node_map_handlers,node_map_pages,node_map_client,node_geo_serializers,node_asset_models,node_postgres toneAmber
class node_complaint_flow,node_complaint_model toneMint
class node_load_command,node_layer_loader toneRose
class node_administrator,node_email_service toneIndigo
```

## Components

### Identity and Access

- [User Routes](https://github.com/sandesh339/ums/blob/master/user/urls.py): `user/urls.py`
- [Account Workflows](https://github.com/sandesh339/ums/blob/master/user/viewset.py): `user/viewset.py`
- [User Serializer](https://github.com/sandesh339/ums/blob/master/user/serializers.py): `user/serializers.py`
- [User Account](https://github.com/sandesh339/ums/blob/master/user/models.py): `user/models.py`

### Campus Mapping

- [Utility Routes](https://github.com/sandesh339/ums/blob/master/utilities/urls.py): `utilities/urls.py`
- [Map and Asset APIs](https://github.com/sandesh339/ums/blob/master/utilities/viewset.py): `utilities/viewset.py`
- [Map Pages](https://github.com/sandesh339/ums/tree/master/utilities/templates/utilities): `utilities/templates/utilities`
- [Map Client](https://github.com/sandesh339/ums/tree/master/utilities/static/utilities/js): `utilities/static/utilities/js`
- [Geo Serializers](https://github.com/sandesh339/ums/blob/master/utilities/serializers.py): `utilities/serializers.py`
- [Campus Asset Data](https://github.com/sandesh339/ums/blob/master/utilities/models.py): `utilities/models.py`

### Utility Complaints

- [Complaint Handling](https://github.com/sandesh339/ums/blob/master/utilities/viewset.py): `utilities/viewset.py`
- [Complaint Records](https://github.com/sandesh339/ums/blob/master/utilities/models.py): `utilities/models.py`

### Geospatial Ingestion

- [Load Command](https://github.com/sandesh339/ums/blob/master/utilities/management/commands/uploaddata.py): `utilities/management/commands/uploaddata.py`
- [Shapefile Loader](https://github.com/sandesh339/ums/blob/master/utilities/load.py): `utilities/load.py`

### Other components

- **Visitor or User**
- **Administrator**
- **Email Service**
- **PostgreSQL Database**

## Connections

- Visitor or User → User Routes: opens account routes (evidence: `user/urls.py`)
- User Routes → Account Workflows: routes requests (evidence: `user/urls.py`)
- Account Workflows → User Serializer: validates registration (evidence: `user/viewset.py`)
- Account Workflows → User Account: reads and saves (evidence: `user/viewset.py`)
- Account Workflows → Email Service: sends account email (evidence: `user/viewset.py`)
- Visitor or User → Utility Routes: opens utility pages (evidence: `utilities/urls.py`)
- Utility Routes → Map and Asset APIs: routes requests (evidence: `utilities/urls.py`)
- Map and Asset APIs → Map Pages: renders pages (evidence: `utilities/viewset.py`)
- Map and Asset APIs → Geo Serializers: serializes asset data (evidence: `utilities/viewset.py`)
- Map and Asset APIs → Campus Asset Data: queries assets (evidence: `utilities/viewset.py`)
- Visitor or User → Utility Routes: uses map interface
- Administrator → Utility Routes: manages complaints
- Complaint Handling → Complaint Records: creates and updates (evidence: `utilities/viewset.py`)
- Complaint Handling → Campus Asset Data: checks boundary (evidence: `utilities/viewset.py`)
- Complaint Handling → Geo Serializers: validates complaint data (evidence: `utilities/viewset.py`)
- Complaint Handling → Email Service: emails resolution (evidence: `utilities/viewset.py`)
- Load Command → Shapefile Loader: runs layer imports (evidence: `utilities/management/commands/uploaddata.py`)
- Shapefile Loader → Campus Asset Data: loads geographic layers (evidence: `utilities/load.py`)
- Campus Asset Data → PostgreSQL Database: persists geographic records (evidence: `README.md`)
- Complaint Records → PostgreSQL Database: persists complaints (evidence: `README.md`)
- User Account → PostgreSQL Database: persists accounts (evidence: `README.md`)
