# biranchikulesika/netram architecture

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

- Interactive diagram: https://gitdiagram.com/biranchikulesika/netram
- Repository: https://github.com/biranchikulesika/netram

## Overview

Netram is a government-institution monitoring platform. Authorities use the web workspaces to review projects, inspections, grievances, funding, and live signals; inspectors capture field evidence in the mobile app, including offline. The API is the authoritative workflow layer for permissions and lifecycle changes, backed by shared persistence and object storage. CCTV streaming, advisory anomaly review, and authorized realtime delivery are major complementary capabilities. Relationships below follow README-documented flows and the supplied source excerpts; unsampled domain internals are represented by their existing module directories.

Main entry points: [`services/api/src/app.ts`](https://github.com/biranchikulesika/netram/blob/production/services/api/src/app.ts) (REST API), [`apps/web/app/dashboard`](https://github.com/biranchikulesika/netram/tree/production/apps/web/app/dashboard) (Web workspaces), [`services/api/src/modules/inspections`](https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/inspections) (Inspection lifecycle), [`services/realtime/src/server.ts`](https://github.com/biranchikulesika/netram/blob/production/services/realtime/src/server.ts) (Realtime hub)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_clients["User applications"]
  node_web["Web workspaces"]
  node_mobile["Inspector app"]
end

subgraph group_workflow["Operational workflows"]
  node_projects["Project registry"]
  node_inspections["Inspection lifecycle"]
  node_corrective["Corrective actions"]
  node_complaints["Grievances"]
  node_evidence["Evidence capture"]
  node_attendance["Attendance reconciliation"]
  node_funds["Funds and expenses"]
end

subgraph group_platform["Core platform"]
  node_api["REST API<br/>[app.ts]"]
  node_authz["Auth and access"]
end

subgraph group_signals["Monitoring signals"]
  node_financialrisk["Financial risk"]
  node_ai["Advisory AI<br/>[main.py]"]
  node_cctvapi["CCTV controls"]
  node_gateway["CCTV gateway<br/>[server.ts]"]
  node_realtime["Realtime hub<br/>[server.ts]"]
end

subgraph group_shared["Shared infrastructure"]
  node_database[("PostgreSQL<br/>[schema.ts]")]
  node_storage[("Object storage<br/>[object-storage.ts]")]
  node_contracts["Shared contracts"]
end

node_authorities(("Public authorities"))
node_inspectors(("Field inspectors"))
node_mediamtx["MediaMTX"]

node_authorities -->|"review workflows"| node_web
node_inspectors -->|"capture inspections"| node_mobile
node_web -->|"request operations"| node_api
node_mobile -->|"sync operations"| node_api
node_api -->|"enforce access"| node_authz
node_api -->|"route project operations"| node_projects
node_api -->|"route attendance operations"| node_attendance
node_api -->|"route fund operations"| node_funds
node_api -->|"route camera operations"| node_cctvapi
node_api -->|"manage lifecycle"| node_inspections
node_inspections -->|"raise corrective actions"| node_corrective
node_inspections -->|"record evidence"| node_evidence
node_api -->|"manage grievances"| node_complaints
node_api -->|"evaluate financial signals"| node_financialrisk
node_attendance -.->|"provide anomaly inputs"| node_ai
node_cctvapi -->|"request stream control"| node_gateway
node_gateway -->|"provision media paths"| node_mediamtx
node_api -->|"persist authoritative state"| node_database
node_api -.->|"store evidence objects"| node_storage
node_realtime -->|"poll outbox"| node_database
node_realtime -->|"deliver authorized events"| node_web
node_api -->|"use domain contracts"| node_contracts
node_financialrisk -.->|"surface review signals"| node_web

click node_web "https://github.com/biranchikulesika/netram/tree/production/apps/web/app/dashboard"
click node_mobile "https://github.com/biranchikulesika/netram/tree/production/apps/inspector-mobile/app"
click node_api "https://github.com/biranchikulesika/netram/blob/production/services/api/src/app.ts"
click node_authz "https://github.com/biranchikulesika/netram/blob/production/services/api/src/modules/authorization/application/authorization-service.ts"
click node_projects "https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/projects"
click node_inspections "https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/inspections"
click node_corrective "https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/corrective-actions"
click node_complaints "https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/complaints"
click node_evidence "https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/evidence"
click node_attendance "https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/attendance"
click node_funds "https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/funds"
click node_financialrisk "https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/financial-risk"
click node_ai "https://github.com/biranchikulesika/netram/blob/production/services/ai/app/main.py"
click node_cctvapi "https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/cctv"
click node_gateway "https://github.com/biranchikulesika/netram/blob/production/services/cctv-gateway/src/server.ts"
click node_realtime "https://github.com/biranchikulesika/netram/blob/production/services/realtime/src/server.ts"
click node_database "https://github.com/biranchikulesika/netram/blob/production/packages/data/src/db/schema.ts"
click node_storage "https://github.com/biranchikulesika/netram/blob/production/services/api/src/infrastructure/object-storage.ts"
click node_contracts "https://github.com/biranchikulesika/netram/tree/production/packages/types/src"

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_web,node_mobile toneBlue
class node_projects,node_inspections,node_corrective,node_complaints,node_evidence,node_attendance,node_funds toneAmber
class node_api,node_authz toneMint
class node_financialrisk,node_ai,node_cctvapi,node_gateway,node_realtime toneRose
class node_database,node_storage,node_contracts,node_authorities,node_inspectors,node_mediamtx toneIndigo
```

## Components

### User applications

- [Web workspaces](https://github.com/biranchikulesika/netram/tree/production/apps/web/app/dashboard): `apps/web/app/dashboard`
- [Inspector app](https://github.com/biranchikulesika/netram/tree/production/apps/inspector-mobile/app): `apps/inspector-mobile/app`

### Operational workflows

- [Project registry](https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/projects): `services/api/src/modules/projects`
- [Inspection lifecycle](https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/inspections): `services/api/src/modules/inspections`
- [Corrective actions](https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/corrective-actions): `services/api/src/modules/corrective-actions`
- [Grievances](https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/complaints): `services/api/src/modules/complaints`
- [Evidence capture](https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/evidence): `services/api/src/modules/evidence`
- [Attendance reconciliation](https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/attendance): `services/api/src/modules/attendance`
- [Funds and expenses](https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/funds): `services/api/src/modules/funds`

### Core platform

- [REST API](https://github.com/biranchikulesika/netram/blob/production/services/api/src/app.ts): `services/api/src/app.ts`
- [Auth and access](https://github.com/biranchikulesika/netram/blob/production/services/api/src/modules/authorization/application/authorization-service.ts): `services/api/src/modules/authorization/application/authorization-service.ts`

### Monitoring signals

- [Financial risk](https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/financial-risk): `services/api/src/modules/financial-risk`
- [Advisory AI](https://github.com/biranchikulesika/netram/blob/production/services/ai/app/main.py): `services/ai/app/main.py`
- [CCTV controls](https://github.com/biranchikulesika/netram/tree/production/services/api/src/modules/cctv): `services/api/src/modules/cctv`
- [CCTV gateway](https://github.com/biranchikulesika/netram/blob/production/services/cctv-gateway/src/server.ts): `services/cctv-gateway/src/server.ts`
- [Realtime hub](https://github.com/biranchikulesika/netram/blob/production/services/realtime/src/server.ts): `services/realtime/src/server.ts`

### Shared infrastructure

- [PostgreSQL](https://github.com/biranchikulesika/netram/blob/production/packages/data/src/db/schema.ts): `packages/data/src/db/schema.ts`
- [Object storage](https://github.com/biranchikulesika/netram/blob/production/services/api/src/infrastructure/object-storage.ts): `services/api/src/infrastructure/object-storage.ts`
- [Shared contracts](https://github.com/biranchikulesika/netram/tree/production/packages/types/src): `packages/types/src`

### Other components

- **Public authorities**
- **Field inspectors**
- **MediaMTX**

## Connections

- Public authorities → Web workspaces: review workflows (evidence: `README.md`)
- Field inspectors → Inspector app: capture inspections (evidence: `README.md`)
- Web workspaces → REST API: request operations
- Inspector app → REST API: sync operations (evidence: `README.md`)
- REST API → Auth and access: enforce access (evidence: `README.md`)
- REST API → Project registry: route project operations (evidence: `services/api/src/modules/projects/http/routes.ts`)
- REST API → Attendance reconciliation: route attendance operations (evidence: `services/api/src/modules/attendance/http/routes.ts`)
- REST API → Funds and expenses: route fund operations (evidence: `services/api/src/modules/funds/http/routes.ts`)
- REST API → CCTV controls: route camera operations (evidence: `services/api/src/modules/cctv/http/routes.ts`)
- REST API → Inspection lifecycle: manage lifecycle (evidence: `README.md`)
- Inspection lifecycle → Corrective actions: raise corrective actions (evidence: `README.md`)
- Inspection lifecycle → Evidence capture: record evidence (evidence: `README.md`)
- REST API → Grievances: manage grievances (evidence: `README.md`)
- REST API → Financial risk: evaluate financial signals (evidence: `README.md`)
- Attendance reconciliation → Advisory AI: provide anomaly inputs (evidence: `README.md`)
- CCTV controls → CCTV gateway: request stream control (evidence: `README.md`)
- CCTV gateway → MediaMTX: provision media paths
- REST API → PostgreSQL: persist authoritative state (evidence: `README.md`)
- REST API → Object storage: store evidence objects (evidence: `README.md`)
- Realtime hub → PostgreSQL: poll outbox (evidence: `services/realtime/src/server.ts`)
- Realtime hub → Web workspaces: deliver authorized events (evidence: `README.md`)
- REST API → Shared contracts: use domain contracts (evidence: `README.md`)
- Financial risk → Web workspaces: surface review signals (evidence: `README.md`)
