# ngtruongmetin/edp architecture

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

- Interactive diagram: https://gitdiagram.com/ngtruongmetin/edp
- Repository: https://github.com/ngtruongmetin/edp

## Overview

EDP is a school discipline and duty-management platform. Users view public information or sign in to role-specific dashboards; co-do users record duty activity, while administrators manage schedules, rules, classes, bonus uploads, and close/report on scoring periods. The frontend routes these experiences and communicates with backend modules, which use a PostgreSQL compatibility layer. The README documents PostgreSQL startup and deployment; sampled source confirms routing and database mechanics, while many page and route implementations were not sampled, so their relationships are shown only where documented or marked unverified.

Main entry points: [`backend/server.js`](https://github.com/ngtruongmetin/edp/blob/main/backend/server.js) (HTTP server), [`backend/db.js`](https://github.com/ngtruongmetin/edp/blob/main/backend/db.js) (Database adapter), [`frontend/src/App.tsx`](https://github.com/ngtruongmetin/edp/blob/main/frontend/src/App.tsx) (Role-based routes), [`frontend/src/api/api.ts`](https://github.com/ngtruongmetin/edp/blob/main/frontend/src/api/api.ts) (API client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Web application"]
  node_app["Role-based routes<br/>[App.tsx]"]
  node_public_ui["Public pages<br/>[Landing.tsx]"]
  node_role_dashboards["Role dashboards<br/>[GvcnDashboard.tsx]"]
  node_duty_ui["Duty interface<br/>[CodoDuty.tsx]"]
  node_admin_ui["Admin tools"]
  node_api_client["API client<br/>[api.ts]"]
end

subgraph group_identity["Access and setup"]
  node_backend["HTTP server<br/>[server.js]"]
  node_auth["Authentication<br/>[routes.js]"]
  node_accounts["Account management<br/>[routes.js]"]
  node_access["Role checks<br/>[requireRole.js]"]
end

subgraph group_operations["School operations"]
  node_classes_rules["Classes and rules<br/>[routes.js]"]
  node_schedule["Duty schedules<br/>[routes.js]"]
  node_duty["Duty records<br/>[routes.js]"]
  node_auto_duty["Duty automation<br/>[dutyAutoCreate.js]"]
end

subgraph group_results["Scoring and reports"]
  node_bonus["Bonus uploads<br/>[routes.js]"]
  node_summaries["Scoring summaries<br/>[routes.js]"]
end

subgraph group_storage["Persistence"]
  node_db_adapter["Database adapter<br/>[db.js]"]
  node_db_helpers["Query helpers<br/>[dbp.js]"]
  node_pool["Postgres pool<br/>[database.js]"]
end

node_visitors(("Students and staff"))
node_admins(("Administrators"))
node_postgres[("PostgreSQL")]

node_visitors -->|"open app"| node_app
node_admins -->|"open app"| node_app
node_app -->|"routes to"| node_public_ui
node_app -->|"routes to"| node_role_dashboards
node_app -->|"routes to"| node_duty_ui
node_app -->|"routes to"| node_admin_ui
node_public_ui -.->|"uses API"| node_api_client
node_role_dashboards -.->|"uses API"| node_api_client
node_duty_ui -.->|"uses API"| node_api_client
node_admin_ui -.->|"uses API"| node_api_client
node_api_client -.->|"sends requests"| node_backend
node_backend -->|"mounts routes"| node_auth
node_backend -->|"mounts routes"| node_accounts
node_backend -->|"mounts routes"| node_classes_rules
node_backend -->|"mounts routes"| node_schedule
node_backend -->|"mounts routes"| node_duty
node_backend -->|"mounts routes"| node_bonus
node_auth -->|"queries"| node_db_adapter
node_accounts -->|"queries"| node_db_adapter
node_classes_rules -->|"queries"| node_db_adapter
node_schedule -->|"queries"| node_db_adapter
node_duty -->|"queries"| node_db_adapter
node_bonus -->|"queries"| node_db_adapter
node_duty -->|"computes reports"| node_summaries
node_backend -->|"starts automation"| node_auto_duty
node_auto_duty -->|"queries"| node_db_adapter
node_db_helpers -->|"delegates queries"| node_db_adapter
node_db_adapter -->|"queries"| node_pool
node_pool -->|"connects to"| node_postgres

click node_app "https://github.com/ngtruongmetin/edp/blob/main/frontend/src/App.tsx"
click node_public_ui "https://github.com/ngtruongmetin/edp/blob/main/frontend/src/pages/Landing.tsx"
click node_role_dashboards "https://github.com/ngtruongmetin/edp/blob/main/frontend/src/pages/gvcn/GvcnDashboard.tsx"
click node_duty_ui "https://github.com/ngtruongmetin/edp/blob/main/frontend/src/pages/co_do/CodoDuty.tsx"
click node_admin_ui "https://github.com/ngtruongmetin/edp/blob/main/frontend/src/pages/admin/AdminDutyManage.tsx"
click node_api_client "https://github.com/ngtruongmetin/edp/blob/main/frontend/src/api/api.ts"
click node_backend "https://github.com/ngtruongmetin/edp/blob/main/backend/server.js"
click node_auth "https://github.com/ngtruongmetin/edp/blob/main/backend/modules/auth/routes.js"
click node_accounts "https://github.com/ngtruongmetin/edp/blob/main/backend/modules/account/routes.js"
click node_access "https://github.com/ngtruongmetin/edp/blob/main/backend/middleware/requireRole.js"
click node_classes_rules "https://github.com/ngtruongmetin/edp/blob/main/backend/modules/classes/routes.js"
click node_schedule "https://github.com/ngtruongmetin/edp/blob/main/backend/modules/schedule/routes.js"
click node_duty "https://github.com/ngtruongmetin/edp/blob/main/backend/modules/duty/routes.js"
click node_bonus "https://github.com/ngtruongmetin/edp/blob/main/backend/modules/bonus/routes.js"
click node_summaries "https://github.com/ngtruongmetin/edp/blob/main/backend/modules/duty/routes.js"
click node_auto_duty "https://github.com/ngtruongmetin/edp/blob/main/backend/utils/dutyAutoCreate.js"
click node_db_adapter "https://github.com/ngtruongmetin/edp/blob/main/backend/db.js"
click node_db_helpers "https://github.com/ngtruongmetin/edp/blob/main/backend/utils/dbp.js"
click node_pool "https://github.com/ngtruongmetin/edp/blob/main/backend/config/database.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_app,node_public_ui,node_role_dashboards,node_duty_ui,node_admin_ui,node_api_client toneBlue
class node_backend,node_auth,node_accounts,node_access,node_postgres toneAmber
class node_classes_rules,node_schedule,node_duty,node_auto_duty toneMint
class node_bonus,node_summaries toneRose
class node_db_adapter,node_db_helpers,node_pool,node_visitors,node_admins toneIndigo
```

## Components

### Web application

- [Role-based routes](https://github.com/ngtruongmetin/edp/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Public pages](https://github.com/ngtruongmetin/edp/blob/main/frontend/src/pages/Landing.tsx): `frontend/src/pages/Landing.tsx`
- [Role dashboards](https://github.com/ngtruongmetin/edp/blob/main/frontend/src/pages/gvcn/GvcnDashboard.tsx): `frontend/src/pages/gvcn/GvcnDashboard.tsx`
- [Duty interface](https://github.com/ngtruongmetin/edp/blob/main/frontend/src/pages/co_do/CodoDuty.tsx): `frontend/src/pages/co_do/CodoDuty.tsx`
- [Admin tools](https://github.com/ngtruongmetin/edp/blob/main/frontend/src/pages/admin/AdminDutyManage.tsx): `frontend/src/pages/admin/AdminDutyManage.tsx`
- [API client](https://github.com/ngtruongmetin/edp/blob/main/frontend/src/api/api.ts): `frontend/src/api/api.ts`

### Access and setup

- [HTTP server](https://github.com/ngtruongmetin/edp/blob/main/backend/server.js): `backend/server.js`
- [Authentication](https://github.com/ngtruongmetin/edp/blob/main/backend/modules/auth/routes.js): `backend/modules/auth/routes.js`
- [Account management](https://github.com/ngtruongmetin/edp/blob/main/backend/modules/account/routes.js): `backend/modules/account/routes.js`
- [Role checks](https://github.com/ngtruongmetin/edp/blob/main/backend/middleware/requireRole.js): `backend/middleware/requireRole.js`

### School operations

- [Classes and rules](https://github.com/ngtruongmetin/edp/blob/main/backend/modules/classes/routes.js): `backend/modules/classes/routes.js`
- [Duty schedules](https://github.com/ngtruongmetin/edp/blob/main/backend/modules/schedule/routes.js): `backend/modules/schedule/routes.js`
- [Duty records](https://github.com/ngtruongmetin/edp/blob/main/backend/modules/duty/routes.js): `backend/modules/duty/routes.js`
- [Duty automation](https://github.com/ngtruongmetin/edp/blob/main/backend/utils/dutyAutoCreate.js): `backend/utils/dutyAutoCreate.js`

### Scoring and reports

- [Bonus uploads](https://github.com/ngtruongmetin/edp/blob/main/backend/modules/bonus/routes.js): `backend/modules/bonus/routes.js`
- [Scoring summaries](https://github.com/ngtruongmetin/edp/blob/main/backend/modules/duty/routes.js): `backend/modules/duty/routes.js`

### Persistence

- [Database adapter](https://github.com/ngtruongmetin/edp/blob/main/backend/db.js): `backend/db.js`
- [Query helpers](https://github.com/ngtruongmetin/edp/blob/main/backend/utils/dbp.js): `backend/utils/dbp.js`
- [Postgres pool](https://github.com/ngtruongmetin/edp/blob/main/backend/config/database.js): `backend/config/database.js`

### Other components

- **Students and staff**
- **Administrators**
- **PostgreSQL**

## Connections

- Students and staff → Role-based routes: open app (evidence: `frontend/src/App.tsx`)
- Administrators → Role-based routes: open app (evidence: `frontend/src/App.tsx`)
- Role-based routes → Public pages: routes to (evidence: `frontend/src/App.tsx`)
- Role-based routes → Role dashboards: routes to (evidence: `frontend/src/App.tsx`)
- Role-based routes → Duty interface: routes to (evidence: `frontend/src/App.tsx`)
- Role-based routes → Admin tools: routes to (evidence: `frontend/src/App.tsx`)
- Public pages → API client: uses API (evidence: `frontend/src/pages/Landing.tsx`)
- Role dashboards → API client: uses API (evidence: `frontend/src/pages/gvcn/GvcnDashboard.tsx`)
- Duty interface → API client: uses API (evidence: `frontend/src/pages/co_do/CodoDuty.tsx`)
- Admin tools → API client: uses API (evidence: `frontend/src/pages/admin/AdminDutyManage.tsx`)
- API client → HTTP server: sends requests
- HTTP server → Authentication: mounts routes (evidence: `backend/server.js`)
- HTTP server → Account management: mounts routes (evidence: `backend/server.js`)
- HTTP server → Classes and rules: mounts routes (evidence: `backend/server.js`)
- HTTP server → Duty schedules: mounts routes (evidence: `backend/server.js`)
- HTTP server → Duty records: mounts routes (evidence: `backend/server.js`)
- HTTP server → Bonus uploads: mounts routes (evidence: `backend/server.js`)
- Authentication → Database adapter: queries (evidence: `backend/modules/auth/routes.js`)
- Account management → Database adapter: queries (evidence: `backend/modules/account/routes.js`)
- Classes and rules → Database adapter: queries (evidence: `backend/modules/classes/routes.js`)
- Duty schedules → Database adapter: queries (evidence: `backend/modules/schedule/routes.js`)
- Duty records → Database adapter: queries (evidence: `backend/modules/duty/routes.js`)
- Bonus uploads → Database adapter: queries (evidence: `backend/modules/bonus/routes.js`)
- Duty records → Scoring summaries: computes reports (evidence: `backend/modules/duty/routes.js`)
- HTTP server → Duty automation: starts automation (evidence: `backend/server.js`)
- Duty automation → Database adapter: queries (evidence: `backend/utils/dutyAutoCreate.js`)
- Query helpers → Database adapter: delegates queries (evidence: `backend/utils/dbp.js`)
- Database adapter → Postgres pool: queries (evidence: `backend/db.js`)
- Postgres pool → PostgreSQL: connects to
