# bcgov/sims architecture

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

## Overview

SIMS is a student financial-aid management system for students, post-secondary institutions, and ministry staff. Its visible workflow is role-specific API access to application operations, with application services providing and transforming application data; separate routes support confirmation of enrollment, while worker controllers handle application-related background jobs. The repository also documents broader policy-driven business rules and workflow automation. The excerpts establish selected controller-to-service and worker-to-service calls, but do not show the full application modules, persistence wiring, or external integrations.

Main entry points: [`sources/packages/backend/apps/api/src/route-controllers/application/application.controller.service.ts`](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/application/application.controller.service.ts) (Application operations), [`sources/packages/backend/apps/api/src/services/application/application.service.ts`](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/services/application/application.service.ts) (Application service), [`sources/packages/backend/apps/api/src/route-controllers/application/application.students.controller.ts`](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/application/application.students.controller.ts) (Student routes), [`sources/packages/backend/apps/api/src/route-controllers/application/application.aest.controller.ts`](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/application/application.aest.controller.ts) (Ministry routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_access["API access"]
  node_api["API application<br/>[main.ts]"]
  node_auth["Auth and roles"]
end

subgraph group_aid["Aid applications"]
  node_student_routes["Student routes"]
  node_ministry_routes["Ministry routes"]
  node_institution_routes["Institution routes"]
  node_application_logic["Application operations"]
  node_application_service["Application service"]
  node_domain_services["Aid domain services"]
end

subgraph group_enrollment["Enrollment processing"]
  node_coe_routes["Enrollment routes"]
  node_coe_logic["Enrollment operations"]
  node_coe_service["Enrollment processing"]
  node_web_coe["Web enrollment client"]
end

subgraph group_automation["Workflow automation"]
  node_queue["Job queue"]
  node_app_worker["Application worker"]
  node_worker_services["Worker services"]
  node_queue_app_service["Queue application service"]
end

node_students(("Students"))
node_institutions(("Institutions"))
node_ministry(("Ministry staff"))

node_students -.->|"uses"| node_student_routes
node_ministry -.->|"uses"| node_ministry_routes
node_institutions -.->|"uses"| node_institution_routes
node_student_routes -->|"calls"| node_application_logic
node_ministry_routes -->|"calls"| node_application_logic
node_institution_routes -->|"uses"| node_application_logic
node_student_routes -->|"calls"| node_application_service
node_ministry_routes -->|"calls"| node_application_service
node_application_logic -->|"reads"| node_application_service
node_application_service -->|"uses"| node_domain_services
node_coe_routes -->|"calls"| node_coe_logic
node_coe_logic -.->|"delegates"| node_coe_service
node_queue -.->|"dispatches"| node_app_worker
node_app_worker -->|"uses"| node_worker_services
node_web_coe -.->|"requests"| node_coe_routes
node_api -.->|"guards"| node_auth

click node_api "https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/main.ts"
click node_auth "https://github.com/bcgov/sims/tree/main/sources/packages/backend/apps/api/src/auth"
click node_student_routes "https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/application/application.students.controller.ts"
click node_ministry_routes "https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/application/application.aest.controller.ts"
click node_institution_routes "https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/application/application.institutions.controller.ts"
click node_application_logic "https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/application/application.controller.service.ts"
click node_application_service "https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/services/application/application.service.ts"
click node_domain_services "https://github.com/bcgov/sims/tree/main/sources/packages/backend/apps/api/src/services"
click node_coe_routes "https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/confirmation-of-enrollment/confirmation-of-enrollment.institutions.controller.ts"
click node_coe_logic "https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/confirmation-of-enrollment/confirmation-of-enrollment.controller.service.ts"
click node_coe_service "https://github.com/bcgov/sims/blob/main/sources/packages/backend/libs/services/src/confirmation-of-enrollment/confirmation-of-enrollment.service.ts"
click node_app_worker "https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/workers/src/controllers/application/application.controller.ts"
click node_worker_services "https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/workers/src/services/application/application.service.ts"
click node_queue_app_service "https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/queue-consumers/src/services/application/application.service.ts"
click node_web_coe "https://github.com/bcgov/sims/blob/main/sources/packages/web/src/services/ConfirmationOfEnrollmentService.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_api,node_auth toneBlue
class node_student_routes,node_ministry_routes,node_institution_routes,node_application_logic,node_application_service,node_domain_services toneAmber
class node_coe_routes,node_coe_logic,node_coe_service,node_web_coe toneMint
class node_queue,node_app_worker,node_worker_services,node_queue_app_service toneRose
class node_students,node_institutions,node_ministry toneIndigo
```

## Components

### API access

- [API application](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/main.ts): `sources/packages/backend/apps/api/src/main.ts`
- [Auth and roles](https://github.com/bcgov/sims/tree/main/sources/packages/backend/apps/api/src/auth): `sources/packages/backend/apps/api/src/auth`

### Aid applications

- [Student routes](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/application/application.students.controller.ts): `sources/packages/backend/apps/api/src/route-controllers/application/application.students.controller.ts`
- [Ministry routes](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/application/application.aest.controller.ts): `sources/packages/backend/apps/api/src/route-controllers/application/application.aest.controller.ts`
- [Institution routes](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/application/application.institutions.controller.ts): `sources/packages/backend/apps/api/src/route-controllers/application/application.institutions.controller.ts`
- [Application operations](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/application/application.controller.service.ts): `sources/packages/backend/apps/api/src/route-controllers/application/application.controller.service.ts`
- [Application service](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/services/application/application.service.ts): `sources/packages/backend/apps/api/src/services/application/application.service.ts`
- [Aid domain services](https://github.com/bcgov/sims/tree/main/sources/packages/backend/apps/api/src/services): `sources/packages/backend/apps/api/src/services`

### Enrollment processing

- [Enrollment routes](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/confirmation-of-enrollment/confirmation-of-enrollment.institutions.controller.ts): `sources/packages/backend/apps/api/src/route-controllers/confirmation-of-enrollment/confirmation-of-enrollment.institutions.controller.ts`
- [Enrollment operations](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/api/src/route-controllers/confirmation-of-enrollment/confirmation-of-enrollment.controller.service.ts): `sources/packages/backend/apps/api/src/route-controllers/confirmation-of-enrollment/confirmation-of-enrollment.controller.service.ts`
- [Enrollment processing](https://github.com/bcgov/sims/blob/main/sources/packages/backend/libs/services/src/confirmation-of-enrollment/confirmation-of-enrollment.service.ts): `sources/packages/backend/libs/services/src/confirmation-of-enrollment/confirmation-of-enrollment.service.ts`
- [Web enrollment client](https://github.com/bcgov/sims/blob/main/sources/packages/web/src/services/ConfirmationOfEnrollmentService.ts): `sources/packages/web/src/services/ConfirmationOfEnrollmentService.ts`

### Workflow automation

- **Job queue**
- [Application worker](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/workers/src/controllers/application/application.controller.ts): `sources/packages/backend/apps/workers/src/controllers/application/application.controller.ts`
- [Worker services](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/workers/src/services/application/application.service.ts): `sources/packages/backend/apps/workers/src/services/application/application.service.ts`
- [Queue application service](https://github.com/bcgov/sims/blob/main/sources/packages/backend/apps/queue-consumers/src/services/application/application.service.ts): `sources/packages/backend/apps/queue-consumers/src/services/application/application.service.ts`

### Other components

- **Students**
- **Institutions**
- **Ministry staff**

## Connections

- Students → Student routes: uses
- Ministry staff → Ministry routes: uses
- Institutions → Institution routes: uses
- Student routes → Application operations: calls (evidence: `sources/packages/backend/apps/api/src/route-controllers/application/application.students.controller.ts`)
- Ministry routes → Application operations: calls (evidence: `sources/packages/backend/apps/api/src/route-controllers/application/application.aest.controller.ts`)
- Institution routes → Application operations: uses (evidence: `sources/packages/backend/apps/api/src/route-controllers/application/application.institutions.controller.ts`)
- Student routes → Application service: calls (evidence: `sources/packages/backend/apps/api/src/route-controllers/application/application.students.controller.ts`)
- Ministry routes → Application service: calls (evidence: `sources/packages/backend/apps/api/src/route-controllers/application/application.aest.controller.ts`)
- Application operations → Application service: reads (evidence: `sources/packages/backend/apps/api/src/route-controllers/application/application.controller.service.ts`)
- Application service → Aid domain services: uses (evidence: `sources/packages/backend/apps/api/src/services/application/application.service.ts`)
- Enrollment routes → Enrollment operations: calls (evidence: `sources/packages/backend/apps/api/src/route-controllers/confirmation-of-enrollment/confirmation-of-enrollment.institutions.controller.ts`)
- Enrollment operations → Enrollment processing: delegates
- Job queue → Application worker: dispatches
- Application worker → Worker services: uses (evidence: `sources/packages/backend/apps/workers/src/controllers/application/application.controller.ts`)
- Web enrollment client → Enrollment routes: requests
- API application → Auth and roles: guards
