# jumon000/sih2k25 architecture

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

- Interactive diagram: https://gitdiagram.com/jumon000/sih2k25
- Repository: https://github.com/jumon000/sih2k25

## Overview

This is a FastAPI location-safety service: users or devices submit locations, the service checks them against administration zones, and unsafe results can be pushed to user/admin WebSockets; a separate device-alert endpoint can text emergency contacts. It also exposes administration, zone, user, and sweet-spot management plus nearby police-station lookup. The sampled implementation concentrates these behaviors in main.py, backed by SQLAlchemy models and a database session factory. No README was provided, and unsampled route details are not inferred.

Main entry points: [`db_models.py`](https://github.com/jumon000/sih2k25/blob/main/db_models.py) (Domain models), [`main.py`](https://github.com/jumon000/sih2k25/blob/main/main.py) (Location intake), [`database.py`](https://github.com/jumon000/sih2k25/blob/main/database.py) (DB sessions)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API workflows"]
  node_user_admin_api["User management<br/>[main.py]"]
  node_admin_api["Administration setup<br/>[main.py]"]
  node_zone_api["Zone management<br/>[main.py]"]
  node_sweet_spots["Sweet spots<br/>[main.py]"]
  node_police_lookup["Police lookup<br/>[main.py]"]
end

subgraph group_safety["Safety and alerts"]
  node_location_api["Location intake<br/>[main.py]"]
  node_geofence["Zone evaluator<br/>[main.py]"]
  node_realtime["WebSocket alerts<br/>[main.py]"]
  node_device_alert["Device alerts<br/>[main.py]"]
end

subgraph group_storage["Persistence"]
  node_db_models["Domain models<br/>[db_models.py]"]
  node_db_session["DB sessions<br/>[database.py]"]
  node_postgres[("PostgreSQL")]
end

node_user(("User"))
node_device(("Location device"))
node_admin(("Administrator"))
node_twilio["Twilio SMS"]
node_geoapify["Geoapify places"]

node_user -->|"submits location"| node_location_api
node_device -->|"submits location"| node_location_api
node_location_api -->|"checks location"| node_geofence
node_location_api -->|"pushes unsafe result"| node_realtime
node_user -->|"requests alert"| node_device_alert
node_device_alert -->|"sends SMS"| node_twilio
node_user -->|"manages profile"| node_user_admin_api
node_admin -->|"creates administration"| node_admin_api
node_admin -->|"creates zones"| node_zone_api
node_admin -->|"manages spots"| node_sweet_spots
node_user -->|"requests stations"| node_police_lookup
node_police_lookup -->|"queries places"| node_geoapify
node_location_api -->|"gets session"| node_db_session
node_geofence -->|"queries zones and users"| node_db_models
node_user_admin_api -->|"reads and writes"| node_db_models
node_admin_api -->|"creates records"| node_db_models
node_zone_api -->|"stores zone data"| node_db_models
node_sweet_spots -->|"stores spot data"| node_db_models
node_device_alert -->|"loads user contacts"| node_db_models
node_db_session -->|"connects sessions"| node_postgres

click node_location_api "https://github.com/jumon000/sih2k25/blob/main/main.py"
click node_geofence "https://github.com/jumon000/sih2k25/blob/main/main.py"
click node_realtime "https://github.com/jumon000/sih2k25/blob/main/main.py"
click node_device_alert "https://github.com/jumon000/sih2k25/blob/main/main.py"
click node_user_admin_api "https://github.com/jumon000/sih2k25/blob/main/main.py"
click node_admin_api "https://github.com/jumon000/sih2k25/blob/main/main.py"
click node_zone_api "https://github.com/jumon000/sih2k25/blob/main/main.py"
click node_sweet_spots "https://github.com/jumon000/sih2k25/blob/main/main.py"
click node_police_lookup "https://github.com/jumon000/sih2k25/blob/main/main.py"
click node_db_models "https://github.com/jumon000/sih2k25/blob/main/db_models.py"
click node_db_session "https://github.com/jumon000/sih2k25/blob/main/database.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_admin_api,node_admin_api,node_zone_api,node_sweet_spots,node_police_lookup,node_user toneBlue
class node_location_api,node_geofence,node_realtime,node_device_alert toneAmber
class node_db_models,node_db_session,node_postgres,node_geoapify toneMint
class node_device,node_admin,node_twilio toneIndigo
```

## Components

### API workflows

- [User management](https://github.com/jumon000/sih2k25/blob/main/main.py): `main.py`
- [Administration setup](https://github.com/jumon000/sih2k25/blob/main/main.py): `main.py`
- [Zone management](https://github.com/jumon000/sih2k25/blob/main/main.py): `main.py`
- [Sweet spots](https://github.com/jumon000/sih2k25/blob/main/main.py): `main.py`
- [Police lookup](https://github.com/jumon000/sih2k25/blob/main/main.py): `main.py`

### Safety and alerts

- [Location intake](https://github.com/jumon000/sih2k25/blob/main/main.py): `main.py`
- [Zone evaluator](https://github.com/jumon000/sih2k25/blob/main/main.py): `main.py`
- [WebSocket alerts](https://github.com/jumon000/sih2k25/blob/main/main.py): `main.py`
- [Device alerts](https://github.com/jumon000/sih2k25/blob/main/main.py): `main.py`

### Persistence

- [Domain models](https://github.com/jumon000/sih2k25/blob/main/db_models.py): `db_models.py`
- [DB sessions](https://github.com/jumon000/sih2k25/blob/main/database.py): `database.py`
- **PostgreSQL**

### Other components

- **User**
- **Location device**
- **Administrator**
- **Twilio SMS**
- **Geoapify places**

## Connections

- User → Location intake: submits location (evidence: `main.py`)
- Location device → Location intake: submits location (evidence: `main.py`)
- Location intake → Zone evaluator: checks location (evidence: `main.py`)
- Location intake → WebSocket alerts: pushes unsafe result (evidence: `main.py`)
- User → Device alerts: requests alert (evidence: `main.py`)
- Device alerts → Twilio SMS: sends SMS (evidence: `main.py`)
- User → User management: manages profile (evidence: `main.py`)
- Administrator → Administration setup: creates administration (evidence: `main.py`)
- Administrator → Zone management: creates zones (evidence: `main.py`)
- Administrator → Sweet spots: manages spots (evidence: `main.py`)
- User → Police lookup: requests stations (evidence: `main.py`)
- Police lookup → Geoapify places: queries places (evidence: `main.py`)
- Location intake → DB sessions: gets session (evidence: `main.py`)
- Zone evaluator → Domain models: queries zones and users (evidence: `main.py`)
- User management → Domain models: reads and writes (evidence: `main.py`)
- Administration setup → Domain models: creates records (evidence: `main.py`)
- Zone management → Domain models: stores zone data (evidence: `main.py`)
- Sweet spots → Domain models: stores spot data (evidence: `main.py`)
- Device alerts → Domain models: loads user contacts (evidence: `main.py`)
- DB sessions → PostgreSQL: connects sessions (evidence: `database.py`)
