# rapepan/data_dashboard architecture

> Architecture diagram of the GitHub repository rapepan/data_dashboard, 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/rapepan/data_dashboard
- Repository: https://github.com/rapepan/data_dashboard

## Overview

DATA BSTH is a hospital operations dashboard for near-real-time service statistics, with public viewing and additional staff/admin features. The main workflow is a user selecting an operational report and date range, the frontend requesting it from the API, and backend report logic returning data (currently mostly mock); cached report results reduce repeated HOSxP queries. Authentication, feedback, administration, and scheduled cache prewarming are meaningful supporting branches. Some subsystem links are based on README architecture documentation because their implementation was not sampled.

Main entry points: [`backend/src/cache/report-registry.ts`](https://github.com/rapepan/data_dashboard/blob/main/backend/src/cache/report-registry.ts) (Report registry), [`backend/src/controllers/feedback.controller.ts`](https://github.com/rapepan/data_dashboard/blob/main/backend/src/controllers/feedback.controller.ts) (Feedback handling), [`backend/src/server.ts`](https://github.com/rapepan/data_dashboard/blob/main/backend/src/server.ts) (HTTP server), [`backend/src/auth/auth.service.ts`](https://github.com/rapepan/data_dashboard/blob/main/backend/src/auth/auth.service.ts) (Authentication service)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Dashboard frontend"]
  node_webapp["React application<br/>[App.tsx]"]
  node_reportpages["Report pages"]
  node_reporthooks["Report data hooks"]
  node_apiservices["API services"]
  node_apiclient["API client<br/>[apiClient.ts]"]
end

subgraph group_api["Backend API"]
  node_server["HTTP server<br/>[server.ts]"]
  node_routes["API routes"]
  node_controllers["Request controllers"]
end

subgraph group_reports["Reports and cache"]
  node_reportservices["Report services"]
  node_reportregistry["Report registry<br/>[report-registry.ts]"]
  node_reportcache[("Report cache<br/>[report-cache.ts]")]
  node_prewarm["Cache prewarming<br/>[prewarm.ts]"]
  node_hosxp["HOSxP repository"]
end

subgraph group_identity["Identity and operations"]
  node_authcontroller["Authentication controller<br/>[auth.controller.ts]"]
  node_authservice["Authentication service<br/>[auth.service.ts]"]
  node_authmiddleware["Session and access checks<br/>[auth.ts]"]
  node_appdb[("Application database<br/>[app-db.ts]")]
  node_audit[("Audit log<br/>[audit-log.ts]")]
  node_feedbackcontroller["Feedback handling"]
  node_feedbackstore[("Feedback storage<br/>[feedback-store.ts]")]
  node_feedbackimages["Feedback images<br/>[feedback-images.ts]"]
  node_notify["Telegram notifications<br/>[notify.service.ts]"]
end

node_user(("Hospital user"))
node_staff(("HOSxP staff accounts"))
node_telegram(("Telegram"))

node_user -->|"opens"| node_webapp
node_webapp -->|"routes to"| node_reportpages
node_reportpages -.->|"loads reports"| node_reporthooks
node_reporthooks -->|"requests data"| node_apiservices
node_apiservices -->|"uses"| node_apiclient
node_apiclient -->|"calls API"| node_server
node_server -->|"builds app"| node_routes
node_routes -->|"routes requests"| node_controllers
node_controllers -->|"calls services"| node_reportservices
node_reportservices -.->|"loads report data"| node_reportregistry
node_reportregistry -->|"uses cache"| node_reportcache
node_prewarm -->|"prewarms"| node_reportcache
node_prewarm -->|"loads reports"| node_reportregistry
node_reportregistry -.->|"queries optionally"| node_hosxp
node_staff -->|"submits login"| node_authcontroller
node_authcontroller -->|"verifies credentials"| node_authservice
node_authservice -->|"checks account"| node_hosxp
node_authservice -->|"checks throttle"| node_appdb
node_server -->|"registers"| node_authmiddleware
node_authmiddleware -->|"records access"| node_audit
node_feedbackcontroller -->|"reads and writes"| node_feedbackstore
node_feedbackcontroller -->|"parses images"| node_feedbackimages
node_feedbackcontroller -->|"notifies"| node_notify
node_notify -->|"sends alerts"| node_telegram

click node_webapp "https://github.com/rapepan/data_dashboard/blob/main/frontend/src/App.tsx"
click node_reportpages "https://github.com/rapepan/data_dashboard/tree/main/frontend/src/pages"
click node_reporthooks "https://github.com/rapepan/data_dashboard/tree/main/frontend/src/hooks"
click node_apiservices "https://github.com/rapepan/data_dashboard/tree/main/frontend/src/services"
click node_apiclient "https://github.com/rapepan/data_dashboard/blob/main/frontend/src/services/apiClient.ts"
click node_server "https://github.com/rapepan/data_dashboard/blob/main/backend/src/server.ts"
click node_routes "https://github.com/rapepan/data_dashboard/tree/main/backend/src/routes"
click node_controllers "https://github.com/rapepan/data_dashboard/tree/main/backend/src/controllers"
click node_reportservices "https://github.com/rapepan/data_dashboard/tree/main/backend/src/services"
click node_reportregistry "https://github.com/rapepan/data_dashboard/blob/main/backend/src/cache/report-registry.ts"
click node_reportcache "https://github.com/rapepan/data_dashboard/blob/main/backend/src/cache/report-cache.ts"
click node_prewarm "https://github.com/rapepan/data_dashboard/blob/main/backend/src/cache/prewarm.ts"
click node_hosxp "https://github.com/rapepan/data_dashboard/blob/main/backend/src/repositories/hosxp.repository.ts"
click node_authcontroller "https://github.com/rapepan/data_dashboard/blob/main/backend/src/controllers/auth.controller.ts"
click node_authservice "https://github.com/rapepan/data_dashboard/blob/main/backend/src/auth/auth.service.ts"
click node_authmiddleware "https://github.com/rapepan/data_dashboard/blob/main/backend/src/middleware/auth.ts"
click node_appdb "https://github.com/rapepan/data_dashboard/blob/main/backend/src/repositories/app-db.ts"
click node_audit "https://github.com/rapepan/data_dashboard/blob/main/backend/src/auth/audit-log.ts"
click node_feedbackcontroller "https://github.com/rapepan/data_dashboard/blob/main/backend/src/controllers/feedback.controller.ts"
click node_feedbackstore "https://github.com/rapepan/data_dashboard/blob/main/backend/src/feedback/feedback-store.ts"
click node_feedbackimages "https://github.com/rapepan/data_dashboard/blob/main/backend/src/feedback/feedback-images.ts"
click node_notify "https://github.com/rapepan/data_dashboard/blob/main/backend/src/services/notify.service.ts"

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_webapp,node_reportpages,node_reporthooks,node_apiservices,node_apiclient,node_user toneBlue
class node_server,node_routes,node_controllers toneAmber
class node_reportservices,node_reportregistry,node_reportcache,node_prewarm,node_hosxp toneMint
class node_authcontroller,node_authservice,node_authmiddleware,node_appdb,node_audit,node_feedbackcontroller,node_feedbackstore,node_feedbackimages,node_notify toneRose
class node_staff,node_telegram toneIndigo
```

## Components

### Dashboard frontend

- [React application](https://github.com/rapepan/data_dashboard/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Report pages](https://github.com/rapepan/data_dashboard/tree/main/frontend/src/pages): `frontend/src/pages`
- [Report data hooks](https://github.com/rapepan/data_dashboard/tree/main/frontend/src/hooks): `frontend/src/hooks`
- [API services](https://github.com/rapepan/data_dashboard/tree/main/frontend/src/services): `frontend/src/services`
- [API client](https://github.com/rapepan/data_dashboard/blob/main/frontend/src/services/apiClient.ts): `frontend/src/services/apiClient.ts`

### Backend API

- [HTTP server](https://github.com/rapepan/data_dashboard/blob/main/backend/src/server.ts): `backend/src/server.ts`
- [API routes](https://github.com/rapepan/data_dashboard/tree/main/backend/src/routes): `backend/src/routes`
- [Request controllers](https://github.com/rapepan/data_dashboard/tree/main/backend/src/controllers): `backend/src/controllers`

### Reports and cache

- [Report services](https://github.com/rapepan/data_dashboard/tree/main/backend/src/services): `backend/src/services`
- [Report registry](https://github.com/rapepan/data_dashboard/blob/main/backend/src/cache/report-registry.ts): `backend/src/cache/report-registry.ts`
- [Report cache](https://github.com/rapepan/data_dashboard/blob/main/backend/src/cache/report-cache.ts): `backend/src/cache/report-cache.ts`
- [Cache prewarming](https://github.com/rapepan/data_dashboard/blob/main/backend/src/cache/prewarm.ts): `backend/src/cache/prewarm.ts`
- [HOSxP repository](https://github.com/rapepan/data_dashboard/blob/main/backend/src/repositories/hosxp.repository.ts): `backend/src/repositories/hosxp.repository.ts`

### Identity and operations

- [Authentication controller](https://github.com/rapepan/data_dashboard/blob/main/backend/src/controllers/auth.controller.ts): `backend/src/controllers/auth.controller.ts`
- [Authentication service](https://github.com/rapepan/data_dashboard/blob/main/backend/src/auth/auth.service.ts): `backend/src/auth/auth.service.ts`
- [Session and access checks](https://github.com/rapepan/data_dashboard/blob/main/backend/src/middleware/auth.ts): `backend/src/middleware/auth.ts`
- [Application database](https://github.com/rapepan/data_dashboard/blob/main/backend/src/repositories/app-db.ts): `backend/src/repositories/app-db.ts`
- [Audit log](https://github.com/rapepan/data_dashboard/blob/main/backend/src/auth/audit-log.ts): `backend/src/auth/audit-log.ts`
- [Feedback handling](https://github.com/rapepan/data_dashboard/blob/main/backend/src/controllers/feedback.controller.ts): `backend/src/controllers/feedback.controller.ts`
- [Feedback storage](https://github.com/rapepan/data_dashboard/blob/main/backend/src/feedback/feedback-store.ts): `backend/src/feedback/feedback-store.ts`
- [Feedback images](https://github.com/rapepan/data_dashboard/blob/main/backend/src/feedback/feedback-images.ts): `backend/src/feedback/feedback-images.ts`
- [Telegram notifications](https://github.com/rapepan/data_dashboard/blob/main/backend/src/services/notify.service.ts): `backend/src/services/notify.service.ts`

### Other components

- **Hospital user**
- **HOSxP staff accounts**
- **Telegram**

## Connections

- Hospital user → React application: opens (evidence: `README.md`)
- React application → Report pages: routes to
- Report pages → Report data hooks: loads reports (evidence: `frontend/src/pages/Icd10SearchPage.tsx`)
- Report data hooks → API services: requests data (evidence: `frontend/src/hooks/useDashboardData.ts`)
- API services → API client: uses (evidence: `frontend/src/services/feedbackService.ts`)
- API client → HTTP server: calls API (evidence: `frontend/src/services/apiClient.ts`)
- HTTP server → API routes: builds app
- API routes → Request controllers: routes requests (evidence: `README.md`)
- Request controllers → Report services: calls services (evidence: `README.md`)
- Report services → Report registry: loads report data (evidence: `README.md`)
- Report registry → Report cache: uses cache (evidence: `README.md`)
- Cache prewarming → Report cache: prewarms (evidence: `backend/src/cache/prewarm.ts`)
- Cache prewarming → Report registry: loads reports (evidence: `backend/src/cache/prewarm.ts`)
- Report registry → HOSxP repository: queries optionally (evidence: `README.md`)
- HOSxP staff accounts → Authentication controller: submits login (evidence: `README.md`)
- Authentication controller → Authentication service: verifies credentials (evidence: `backend/src/controllers/auth.controller.ts`)
- Authentication service → HOSxP repository: checks account (evidence: `backend/src/auth/auth.service.ts`)
- Authentication service → Application database: checks throttle (evidence: `backend/src/auth/auth.service.ts`)
- HTTP server → Session and access checks: registers (evidence: `backend/src/server.ts`)
- Session and access checks → Audit log: records access (evidence: `backend/src/middleware/auth.ts`)
- Feedback handling → Feedback storage: reads and writes (evidence: `backend/src/controllers/feedback.controller.ts`)
- Feedback handling → Feedback images: parses images (evidence: `backend/src/controllers/feedback.controller.ts`)
- Feedback handling → Telegram notifications: notifies (evidence: `backend/src/controllers/feedback.controller.ts`)
- Telegram notifications → Telegram: sends alerts (evidence: `README.md`)
