# prateek004/updating-dormbook architecture

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

## Overview

DormBook is a property and dormitory management application for handling residents, beds, bookings, payments, finances, staff, and operational reports. The main workflow is staff using the web app to authenticate, enter a routed operation such as check-in, and have the relevant controller read or update SQLite; money-related operations use the central ledger. Reporting and account administration are distinct product branches. The README documents role-based capabilities and optional WhatsApp messaging. Several controller subsystems are represented by their directory because their implementation was not sampled; their detailed internal relationships are therefore omitted.

Main entry points: [`src/routes/index.js`](https://github.com/prateek004/updating-dormbook/blob/main/src/routes/index.js) (API routes), [`src/services/ledger.js`](https://github.com/prateek004/updating-dormbook/blob/main/src/services/ledger.js) (Money ledger), [`src/controllers/checkinController.js`](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/checkinController.js) (Resident check-in), [`src/db/connection.js`](https://github.com/prateek004/updating-dormbook/blob/main/src/db/connection.js) (SQLite database)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Web client"]
  node_webapp["Web app<br/>[app.js]"]
end

subgraph group_access["Access and administration"]
  node_routing["API routes<br/>[index.js]"]
  node_auth["Authentication<br/>[authController.js]"]
  node_accessctrl["Staff access"]
  node_guards["Auth and role guards<br/>[auth.js]"]
  node_permissions["Permission checks<br/>[permissions.js]"]
  node_accounts["Accounts"]
  node_staffadmin["Staff management<br/>[staffController.js]"]
end

subgraph group_operations["Property operations"]
  node_checkin["Resident check-in"]
  node_beds["Beds and rooms<br/>[bedsController.js]"]
  node_bookings["Bookings"]
  node_addons["Add-on charges"]
  node_documents["Resident documents"]
end

subgraph group_finance["Finance and reporting"]
  node_payments["Payments and receipts"]
  node_ledger["Money ledger<br/>[ledger.js]"]
  node_financectrl["Finance operations"]
  node_payroll["Payroll"]
  node_reports["Daily reports"]
  node_registers["Report registers"]
  node_summary["Management summary"]
end

subgraph group_platform["Persistence and services"]
  node_dbinit["Database initialization<br/>[init.js]"]
  node_database[("SQLite database<br/>[connection.js]")]
  node_audit["Audit logging<br/>[auditLog.js]"]
  node_whatsapp["WhatsApp notifications<br/>[whatsappService.js]"]
  node_time["IST time utilities<br/>[time.js]"]
  node_idproof["ID proof utilities<br/>[idproof.js]"]
end

node_staff(("Property staff"))
node_provider(("WhatsApp provider"))

node_staff -->|"uses"| node_webapp
node_webapp -.->|"calls API"| node_routing
node_routing -->|"routes login"| node_auth
node_routing -->|"guards requests"| node_guards
node_routing -->|"routes check-in"| node_checkin
node_routing -->|"routes bed setup"| node_beds
node_routing -->|"routes payments"| node_payments
node_routing -->|"routes dashboard"| node_financectrl
node_routing -->|"routes reports"| node_reports
node_routing -->|"routes bookings"| node_bookings
node_routing -->|"checks permissions"| node_permissions
node_auth -->|"reads users"| node_database
node_guards -->|"checks user"| node_database
node_permissions -->|"loads permissions"| node_database
node_checkin -->|"reads and writes"| node_database
node_checkin -->|"logs access"| node_audit
node_checkin -->|"schedules notice"| node_whatsapp
node_checkin -->|"uses ledger"| node_ledger
node_checkin -->|"formats ID"| node_idproof
node_payments -->|"records transactions"| node_ledger
node_payments -->|"sends notice"| node_whatsapp
node_payments -->|"reads and writes"| node_database
node_financectrl -->|"uses ledger"| node_ledger
node_reports -->|"reads balances"| node_ledger
node_registers -->|"builds registers"| node_ledger
node_summary -->|"uses ledger"| node_ledger
node_dbinit -->|"initializes connection"| node_database
node_dbinit -->|"sets up ledger"| node_ledger
node_ledger -->|"reads and writes"| node_database
node_reports -->|"uses date helpers"| node_time
node_registers -.->|"uses date helpers"| node_time
node_summary -.->|"uses ID helpers"| node_idproof
node_whatsapp -.->|"sends messages"| node_provider
node_accounts -->|"uses ledger"| node_ledger
node_addons -->|"records charges"| node_ledger
node_payroll -->|"records payroll"| node_ledger

click node_webapp "https://github.com/prateek004/updating-dormbook/blob/main/public/js/app.js"
click node_routing "https://github.com/prateek004/updating-dormbook/blob/main/src/routes/index.js"
click node_auth "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/authController.js"
click node_accessctrl "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/accessController.js"
click node_guards "https://github.com/prateek004/updating-dormbook/blob/main/src/middleware/auth.js"
click node_permissions "https://github.com/prateek004/updating-dormbook/blob/main/src/middleware/permissions.js"
click node_accounts "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/accountsController.js"
click node_staffadmin "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/staffController.js"
click node_checkin "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/checkinController.js"
click node_beds "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/bedsController.js"
click node_bookings "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/bookingsController.js"
click node_addons "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/addonsController.js"
click node_documents "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/documentsController.js"
click node_payments "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/paymentsController.js"
click node_ledger "https://github.com/prateek004/updating-dormbook/blob/main/src/services/ledger.js"
click node_financectrl "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/financeController.js"
click node_payroll "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/payrollController.js"
click node_reports "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/dailyReportsController.js"
click node_registers "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/registersController.js"
click node_summary "https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/summaryController.js"
click node_dbinit "https://github.com/prateek004/updating-dormbook/blob/main/src/db/init.js"
click node_database "https://github.com/prateek004/updating-dormbook/blob/main/src/db/connection.js"
click node_audit "https://github.com/prateek004/updating-dormbook/blob/main/src/middleware/auditLog.js"
click node_whatsapp "https://github.com/prateek004/updating-dormbook/blob/main/src/services/whatsappService.js"
click node_time "https://github.com/prateek004/updating-dormbook/blob/main/src/util/time.js"
click node_idproof "https://github.com/prateek004/updating-dormbook/blob/main/src/util/idproof.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_webapp toneBlue
class node_routing,node_auth,node_accessctrl,node_guards,node_permissions,node_accounts,node_staffadmin toneAmber
class node_checkin,node_beds,node_bookings,node_addons,node_documents toneMint
class node_payments,node_ledger,node_financectrl,node_payroll,node_reports,node_registers,node_summary toneRose
class node_dbinit,node_database,node_audit,node_whatsapp,node_time,node_idproof,node_staff,node_provider toneIndigo
```

## Components

### Web client

- [Web app](https://github.com/prateek004/updating-dormbook/blob/main/public/js/app.js): `public/js/app.js`

### Access and administration

- [API routes](https://github.com/prateek004/updating-dormbook/blob/main/src/routes/index.js): `src/routes/index.js`
- [Authentication](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/authController.js): `src/controllers/authController.js`
- [Staff access](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/accessController.js): `src/controllers/accessController.js`
- [Auth and role guards](https://github.com/prateek004/updating-dormbook/blob/main/src/middleware/auth.js): `src/middleware/auth.js`
- [Permission checks](https://github.com/prateek004/updating-dormbook/blob/main/src/middleware/permissions.js): `src/middleware/permissions.js`
- [Accounts](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/accountsController.js): `src/controllers/accountsController.js`
- [Staff management](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/staffController.js): `src/controllers/staffController.js`

### Property operations

- [Resident check-in](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/checkinController.js): `src/controllers/checkinController.js`
- [Beds and rooms](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/bedsController.js): `src/controllers/bedsController.js`
- [Bookings](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/bookingsController.js): `src/controllers/bookingsController.js`
- [Add-on charges](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/addonsController.js): `src/controllers/addonsController.js`
- [Resident documents](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/documentsController.js): `src/controllers/documentsController.js`

### Finance and reporting

- [Payments and receipts](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/paymentsController.js): `src/controllers/paymentsController.js`
- [Money ledger](https://github.com/prateek004/updating-dormbook/blob/main/src/services/ledger.js): `src/services/ledger.js`
- [Finance operations](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/financeController.js): `src/controllers/financeController.js`
- [Payroll](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/payrollController.js): `src/controllers/payrollController.js`
- [Daily reports](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/dailyReportsController.js): `src/controllers/dailyReportsController.js`
- [Report registers](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/registersController.js): `src/controllers/registersController.js`
- [Management summary](https://github.com/prateek004/updating-dormbook/blob/main/src/controllers/summaryController.js): `src/controllers/summaryController.js`

### Persistence and services

- [Database initialization](https://github.com/prateek004/updating-dormbook/blob/main/src/db/init.js): `src/db/init.js`
- [SQLite database](https://github.com/prateek004/updating-dormbook/blob/main/src/db/connection.js): `src/db/connection.js`
- [Audit logging](https://github.com/prateek004/updating-dormbook/blob/main/src/middleware/auditLog.js): `src/middleware/auditLog.js`
- [WhatsApp notifications](https://github.com/prateek004/updating-dormbook/blob/main/src/services/whatsappService.js): `src/services/whatsappService.js`
- [IST time utilities](https://github.com/prateek004/updating-dormbook/blob/main/src/util/time.js): `src/util/time.js`
- [ID proof utilities](https://github.com/prateek004/updating-dormbook/blob/main/src/util/idproof.js): `src/util/idproof.js`

### Other components

- **Property staff**
- **WhatsApp provider**

## Connections

- Property staff → Web app: uses
- Web app → API routes: calls API
- API routes → Authentication: routes login (evidence: `src/routes/index.js`)
- API routes → Auth and role guards: guards requests (evidence: `src/routes/index.js`)
- API routes → Resident check-in: routes check-in (evidence: `src/routes/index.js`)
- API routes → Beds and rooms: routes bed setup (evidence: `src/routes/index.js`)
- API routes → Payments and receipts: routes payments (evidence: `src/routes/index.js`)
- API routes → Finance operations: routes dashboard (evidence: `src/routes/index.js`)
- API routes → Daily reports: routes reports (evidence: `src/routes/index.js`)
- API routes → Bookings: routes bookings (evidence: `src/routes/index.js`)
- API routes → Permission checks: checks permissions (evidence: `src/routes/index.js`)
- Authentication → SQLite database: reads users (evidence: `src/controllers/authController.js`)
- Auth and role guards → SQLite database: checks user (evidence: `src/middleware/auth.js`)
- Permission checks → SQLite database: loads permissions (evidence: `src/middleware/permissions.js`)
- Resident check-in → SQLite database: reads and writes (evidence: `src/controllers/checkinController.js`)
- Resident check-in → Audit logging: logs access (evidence: `src/controllers/checkinController.js`)
- Resident check-in → WhatsApp notifications: schedules notice (evidence: `src/controllers/checkinController.js`)
- Resident check-in → Money ledger: uses ledger (evidence: `src/controllers/checkinController.js`)
- Resident check-in → ID proof utilities: formats ID (evidence: `src/controllers/checkinController.js`)
- Payments and receipts → Money ledger: records transactions (evidence: `src/controllers/paymentsController.js`)
- Payments and receipts → WhatsApp notifications: sends notice (evidence: `src/controllers/paymentsController.js`)
- Payments and receipts → SQLite database: reads and writes (evidence: `src/controllers/paymentsController.js`)
- Finance operations → Money ledger: uses ledger (evidence: `src/controllers/financeController.js`)
- Daily reports → Money ledger: reads balances (evidence: `src/controllers/dailyReportsController.js`)
- Report registers → Money ledger: builds registers (evidence: `src/controllers/registersController.js`)
- Management summary → Money ledger: uses ledger (evidence: `src/controllers/summaryController.js`)
- Database initialization → SQLite database: initializes connection (evidence: `src/server.js`)
- Database initialization → Money ledger: sets up ledger (evidence: `src/db/init.js`)
- Money ledger → SQLite database: reads and writes (evidence: `src/services/ledger.js`)
- Daily reports → IST time utilities: uses date helpers (evidence: `src/controllers/dailyReportsController.js`)
- Report registers → IST time utilities: uses date helpers (evidence: `src/controllers/registersController.js`)
- Management summary → ID proof utilities: uses ID helpers (evidence: `src/controllers/summaryController.js`)
- WhatsApp notifications → WhatsApp provider: sends messages
- Accounts → Money ledger: uses ledger (evidence: `src/controllers/accountsController.js`)
- Add-on charges → Money ledger: records charges (evidence: `src/controllers/addonsController.js`)
- Payroll → Money ledger: records payroll (evidence: `src/controllers/payrollController.js`)
