# remonalbear/cmms architecture

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

- Interactive diagram: https://gitdiagram.com/remonalbear/cmms
- Repository: https://github.com/remonalbear/cmms

## Overview

This is a hospital-oriented computerized maintenance management system. Admins maintain departments, engineers, equipment and suppliers, then track work orders, breakdowns, maintenance and spare-part inventory; clinical engineers submit daily inspections and planned preventive maintenance (PPM), which admins can review alongside installation and other reports. The source index and excerpts show the server’s route/controller/model structure and several model calls. Some feature wiring is documented in the README but its implementation was not sampled, so those links are marked unverified.

Main entry points: [`controllers/report.js`](https://github.com/remonalbear/cmms/blob/master/controllers/report.js) (Report workflows), [`controllers/home.js`](https://github.com/remonalbear/cmms/blob/master/controllers/home.js) (Home workflows), [`controllers/add.js`](https://github.com/remonalbear/cmms/blob/master/controllers/add.js) (Record creation), [`util/db.js`](https://github.com/remonalbear/cmms/blob/master/util/db.js) (Sequelize connection)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Application routing"]
  node_server["Web server<br/>[server.js]"]
  node_routes["Route dispatch"]
  node_home["Home workflows<br/>[home.js]"]
  node_add["Record creation<br/>[add.js]"]
  node_edits["Record edits<br/>[edit.js]"]
  node_deletes["Record deletion<br/>[delete.js]"]
end

subgraph group_assets["Maintenance records"]
  node_equipment["Equipment<br/>[equipment.js]"]
  node_departments["Departments<br/>[department.js]"]
  node_engineers["Clinical engineers"]
  node_suppliers["Agent suppliers<br/>[agent_supplier.js]"]
  node_spares["Spare parts<br/>[spare_part.js]"]
  node_breakdowns["Breakdowns<br/>[break_down.js]"]
  node_workorders["Work orders<br/>[work_order.js]"]
  node_maintenance["Maintenance<br/>[maintenance.js]"]
end

subgraph group_inspections["Inspection and PPM"]
  node_daily["Daily inspections"]
  node_ppm["PPM records<br/>[ppm.js]"]
  node_questions["PPM questions<br/>[ppm_questions.js]"]
end

subgraph group_reporting["Reports and views"]
  node_reports["Report workflows<br/>[report.js]"]
end

subgraph group_persistence["Persistence"]
  node_db["Sequelize connection<br/>[db.js]"]
  node_mysql[("MySQL database")]
end

node_users(("Admins and engineers"))

node_users -->|"use"| node_server
node_server -->|"mounts"| node_routes
node_routes -->|"dispatches"| node_home
node_routes -->|"dispatches"| node_add
node_routes -->|"dispatches"| node_edits
node_routes -->|"dispatches"| node_deletes
node_routes -->|"dispatches"| node_reports
node_home -->|"queries"| node_equipment
node_home -->|"queries"| node_engineers
node_home -->|"queries"| node_workorders
node_home -->|"queries"| node_breakdowns
node_home -->|"creates and queries"| node_daily
node_home -->|"creates and queries"| node_ppm
node_add -->|"creates"| node_departments
node_add -->|"creates"| node_equipment
node_add -->|"creates"| node_suppliers
node_add -->|"creates"| node_spares
node_add -->|"creates"| node_breakdowns
node_add -->|"creates"| node_workorders
node_add -->|"creates"| node_maintenance
node_reports -->|"queries"| node_equipment
node_reports -->|"queries"| node_daily
node_reports -->|"queries"| node_ppm
node_reports -->|"queries"| node_questions
node_reports -->|"queries"| node_spares
node_equipment -->|"uses"| node_db
node_engineers -->|"uses"| node_db
node_suppliers -->|"uses"| node_db
node_spares -->|"uses"| node_db
node_breakdowns -->|"uses"| node_db
node_workorders -->|"uses"| node_db
node_maintenance -->|"uses"| node_db
node_ppm -->|"uses"| node_db
node_db -->|"connects"| node_mysql
node_reports -.->|"reports on"| node_maintenance
node_reports -.->|"reports on"| node_breakdowns
node_reports -.->|"reports on"| node_engineers
node_reports -.->|"reports on"| node_departments
node_home -.->|"manages"| node_departments
node_home -.->|"manages"| node_suppliers

click node_server "https://github.com/remonalbear/cmms/blob/master/server.js"
click node_routes "https://github.com/remonalbear/cmms/tree/master/routes"
click node_home "https://github.com/remonalbear/cmms/blob/master/controllers/home.js"
click node_add "https://github.com/remonalbear/cmms/blob/master/controllers/add.js"
click node_edits "https://github.com/remonalbear/cmms/blob/master/controllers/edit.js"
click node_deletes "https://github.com/remonalbear/cmms/blob/master/controllers/delete.js"
click node_reports "https://github.com/remonalbear/cmms/blob/master/controllers/report.js"
click node_equipment "https://github.com/remonalbear/cmms/blob/master/models/equipment.js"
click node_departments "https://github.com/remonalbear/cmms/blob/master/models/department.js"
click node_engineers "https://github.com/remonalbear/cmms/blob/master/models/clinical_engineer.js"
click node_suppliers "https://github.com/remonalbear/cmms/blob/master/models/agent_supplier.js"
click node_spares "https://github.com/remonalbear/cmms/blob/master/models/spare_part.js"
click node_breakdowns "https://github.com/remonalbear/cmms/blob/master/models/break_down.js"
click node_workorders "https://github.com/remonalbear/cmms/blob/master/models/work_order.js"
click node_maintenance "https://github.com/remonalbear/cmms/blob/master/models/maintenance.js"
click node_daily "https://github.com/remonalbear/cmms/blob/master/models/dialy_inspection.js"
click node_ppm "https://github.com/remonalbear/cmms/blob/master/models/ppm.js"
click node_questions "https://github.com/remonalbear/cmms/blob/master/models/ppm_questions.js"
click node_db "https://github.com/remonalbear/cmms/blob/master/util/db.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_server,node_routes,node_home,node_add,node_edits,node_deletes toneBlue
class node_equipment,node_departments,node_engineers,node_suppliers,node_spares,node_breakdowns,node_workorders,node_maintenance toneAmber
class node_daily,node_ppm,node_questions toneMint
class node_reports toneRose
class node_db,node_mysql,node_users toneIndigo
```

## Components

### Application routing

- [Web server](https://github.com/remonalbear/cmms/blob/master/server.js): `server.js`
- [Route dispatch](https://github.com/remonalbear/cmms/tree/master/routes): `routes`
- [Home workflows](https://github.com/remonalbear/cmms/blob/master/controllers/home.js): `controllers/home.js`
- [Record creation](https://github.com/remonalbear/cmms/blob/master/controllers/add.js): `controllers/add.js`
- [Record edits](https://github.com/remonalbear/cmms/blob/master/controllers/edit.js): `controllers/edit.js`
- [Record deletion](https://github.com/remonalbear/cmms/blob/master/controllers/delete.js): `controllers/delete.js`

### Maintenance records

- [Equipment](https://github.com/remonalbear/cmms/blob/master/models/equipment.js): `models/equipment.js`
- [Departments](https://github.com/remonalbear/cmms/blob/master/models/department.js): `models/department.js`
- [Clinical engineers](https://github.com/remonalbear/cmms/blob/master/models/clinical_engineer.js): `models/clinical_engineer.js`
- [Agent suppliers](https://github.com/remonalbear/cmms/blob/master/models/agent_supplier.js): `models/agent_supplier.js`
- [Spare parts](https://github.com/remonalbear/cmms/blob/master/models/spare_part.js): `models/spare_part.js`
- [Breakdowns](https://github.com/remonalbear/cmms/blob/master/models/break_down.js): `models/break_down.js`
- [Work orders](https://github.com/remonalbear/cmms/blob/master/models/work_order.js): `models/work_order.js`
- [Maintenance](https://github.com/remonalbear/cmms/blob/master/models/maintenance.js): `models/maintenance.js`

### Inspection and PPM

- [Daily inspections](https://github.com/remonalbear/cmms/blob/master/models/dialy_inspection.js): `models/dialy_inspection.js`
- [PPM records](https://github.com/remonalbear/cmms/blob/master/models/ppm.js): `models/ppm.js`
- [PPM questions](https://github.com/remonalbear/cmms/blob/master/models/ppm_questions.js): `models/ppm_questions.js`

### Reports and views

- [Report workflows](https://github.com/remonalbear/cmms/blob/master/controllers/report.js): `controllers/report.js`

### Persistence

- [Sequelize connection](https://github.com/remonalbear/cmms/blob/master/util/db.js): `util/db.js`
- **MySQL database**

### Other components

- **Admins and engineers**

## Connections

- Admins and engineers → Web server: use (evidence: `README.md`)
- Web server → Route dispatch: mounts (evidence: `server.js`)
- Route dispatch → Home workflows: dispatches (evidence: `routes/main.js`)
- Route dispatch → Record creation: dispatches (evidence: `routes/add.js`)
- Route dispatch → Record edits: dispatches (evidence: `routes/edit.js`)
- Route dispatch → Record deletion: dispatches (evidence: `routes/delete.js`)
- Route dispatch → Report workflows: dispatches (evidence: `routes/report.js`)
- Home workflows → Equipment: queries (evidence: `controllers/home.js`)
- Home workflows → Clinical engineers: queries (evidence: `controllers/home.js`)
- Home workflows → Work orders: queries (evidence: `controllers/home.js`)
- Home workflows → Breakdowns: queries (evidence: `controllers/home.js`)
- Home workflows → Daily inspections: creates and queries (evidence: `controllers/home.js`)
- Home workflows → PPM records: creates and queries (evidence: `controllers/home.js`)
- Record creation → Departments: creates (evidence: `controllers/add.js`)
- Record creation → Equipment: creates (evidence: `controllers/add.js`)
- Record creation → Agent suppliers: creates (evidence: `controllers/add.js`)
- Record creation → Spare parts: creates (evidence: `controllers/add.js`)
- Record creation → Breakdowns: creates (evidence: `controllers/add.js`)
- Record creation → Work orders: creates (evidence: `controllers/add.js`)
- Record creation → Maintenance: creates (evidence: `controllers/add.js`)
- Report workflows → Equipment: queries (evidence: `controllers/report.js`)
- Report workflows → Daily inspections: queries (evidence: `controllers/report.js`)
- Report workflows → PPM records: queries (evidence: `controllers/report.js`)
- Report workflows → PPM questions: queries (evidence: `controllers/report.js`)
- Report workflows → Spare parts: queries (evidence: `controllers/report.js`)
- Equipment → Sequelize connection: uses (evidence: `models/equipment.js`)
- Clinical engineers → Sequelize connection: uses (evidence: `models/clinical_engineer.js`)
- Agent suppliers → Sequelize connection: uses (evidence: `models/agent_supplier.js`)
- Spare parts → Sequelize connection: uses (evidence: `models/spare_part.js`)
- Breakdowns → Sequelize connection: uses (evidence: `models/break_down.js`)
- Work orders → Sequelize connection: uses (evidence: `models/work_order.js`)
- Maintenance → Sequelize connection: uses (evidence: `models/maintenance.js`)
- PPM records → Sequelize connection: uses (evidence: `models/ppm.js`)
- Sequelize connection → MySQL database: connects (evidence: `util/db.js`)
- Report workflows → Maintenance: reports on (evidence: `controllers/report.js`)
- Report workflows → Breakdowns: reports on (evidence: `controllers/report.js`)
- Report workflows → Clinical engineers: reports on (evidence: `controllers/report.js`)
- Report workflows → Departments: reports on (evidence: `controllers/report.js`)
- Home workflows → Departments: manages (evidence: `controllers/home.js`)
- Home workflows → Agent suppliers: manages (evidence: `controllers/home.js`)
