# kiarie-ke/sms architecture

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

- Interactive diagram: https://gitdiagram.com/kiarie-ke/sms
- Repository: https://github.com/kiarie-ke/sms

## Overview

School System is a Kenyan school-management platform with a Next.js role-based interface and a NestJS API backed by Prisma/PostgreSQL. The built user workflow is: sign in, access role-scoped school records, and manage people/structure or record and review daily attendance. Student import and photo upload support administration; attendance absence notices are in-app. Exams, CBC assessment, fees, report cards, audit, and SMS have repository modules, but the README says several remain unfinished. Edges rely on the README and shown source; unsampled module internals are not inferred.

Main entry points: [`apps/api/src/prisma/prisma.service.ts`](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/prisma/prisma.service.ts) (Prisma access), [`apps/api/src/attendance/attendance.service.ts`](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/attendance/attendance.service.ts) (Attendance), [`apps/api/src/auth/auth.controller.ts`](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/auth/auth.controller.ts) (Auth endpoints), [`apps/api/src/people/students/students.service.ts`](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/people/students/students.service.ts) (Student management)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web experience"]
  node_role_ui["Role dashboards"]
  node_login_ui["Login form<br/>[login-form.tsx]"]
  node_web_session["Session routes"]
  node_web_api["API client<br/>[http-client.ts]"]
end

subgraph group_identity["Identity and access"]
  node_auth_controller["Auth endpoints<br/>[auth.controller.ts]"]
  node_auth_service["Authentication<br/>[auth.service.ts]"]
  node_auth_cookie["Auth cookies"]
end

subgraph group_records["People and structure"]
  node_students["Student management"]
  node_student_routes["Student endpoints"]
  node_photo_storage["Photo storage"]
  node_scoping["Role scoping<br/>[scoping.service.ts]"]
  node_school_structure["School structure"]
end

subgraph group_school_ops["School operations"]
  node_attendance["Attendance"]
  node_exams["Exams and marks"]
  node_cbc["CBC assessment"]
  node_report_cards["Report cards"]
  node_fees["Fees"]
  node_notifications["Notifications"]
  node_audit["Audit logs"]
  node_sms["SMS integration"]
end

subgraph group_data["Persistence"]
  node_prisma["Prisma access<br/>[prisma.service.ts]"]
  node_postgres[("PostgreSQL")]
end

node_user(("School user"))
node_cloudinary(("Cloudinary"))

node_user -->|"signs in"| node_login_ui
node_login_ui -->|"starts session"| node_web_session
node_web_session -->|"authenticates"| node_auth_controller
node_auth_controller -->|"delegates to"| node_auth_service
node_auth_controller -->|"sets cookies"| node_auth_cookie
node_user -->|"uses role view"| node_role_ui
node_role_ui -->|"requests records"| node_web_api
node_web_api -->|"calls API"| node_student_routes
node_student_routes -->|"delegates to"| node_students
node_students -->|"checks access"| node_scoping
node_student_routes -->|"uploads photo"| node_photo_storage
node_photo_storage -->|"uploads image"| node_cloudinary
node_user -->|"records or views"| node_attendance
node_attendance -->|"enforces scope"| node_scoping
node_attendance -->|"notifies absence"| node_notifications
node_students -.->|"persists records"| node_prisma
node_attendance -->|"reads and writes"| node_prisma
node_prisma -->|"stores data"| node_postgres
node_school_structure -.->|"persists structure"| node_prisma
node_exams -.->|"stores exam data"| node_prisma
node_cbc -.->|"stores assessment data"| node_prisma
node_report_cards -->|"uses exam marks"| node_exams
node_report_cards -->|"uses CBC results"| node_cbc
node_fees -.->|"stores fee data"| node_prisma
node_audit -.->|"stores audit data"| node_prisma
node_sms -.->|"sends messages"| node_user

click node_role_ui "https://github.com/kiarie-ke/sms/tree/main/apps/web/src/app/(dashboard)"
click node_login_ui "https://github.com/kiarie-ke/sms/blob/main/apps/web/src/components/auth/login-form.tsx"
click node_web_session "https://github.com/kiarie-ke/sms/tree/main/apps/web/src/app/api/session"
click node_web_api "https://github.com/kiarie-ke/sms/blob/main/apps/web/src/lib/api/http-client.ts"
click node_auth_controller "https://github.com/kiarie-ke/sms/blob/main/apps/api/src/auth/auth.controller.ts"
click node_auth_service "https://github.com/kiarie-ke/sms/blob/main/apps/api/src/auth/auth.service.ts"
click node_auth_cookie "https://github.com/kiarie-ke/sms/blob/main/apps/api/src/auth/auth-cookie.service.ts"
click node_students "https://github.com/kiarie-ke/sms/blob/main/apps/api/src/people/students/students.service.ts"
click node_student_routes "https://github.com/kiarie-ke/sms/blob/main/apps/api/src/people/students/students.controller.ts"
click node_photo_storage "https://github.com/kiarie-ke/sms/blob/main/apps/api/src/people/students/photo-storage.service.ts"
click node_scoping "https://github.com/kiarie-ke/sms/blob/main/apps/api/src/scoping/scoping.service.ts"
click node_school_structure "https://github.com/kiarie-ke/sms/tree/main/apps/api/src/structure"
click node_attendance "https://github.com/kiarie-ke/sms/blob/main/apps/api/src/attendance/attendance.service.ts"
click node_exams "https://github.com/kiarie-ke/sms/tree/main/apps/api/src/exams"
click node_cbc "https://github.com/kiarie-ke/sms/tree/main/apps/api/src/cbc"
click node_report_cards "https://github.com/kiarie-ke/sms/blob/main/apps/api/src/report-cards/report-card.service.ts"
click node_fees "https://github.com/kiarie-ke/sms/tree/main/apps/api/src/fees"
click node_notifications "https://github.com/kiarie-ke/sms/tree/main/apps/api/src/notifications"
click node_audit "https://github.com/kiarie-ke/sms/tree/main/apps/api/src/audit"
click node_sms "https://github.com/kiarie-ke/sms/tree/main/apps/api/src/sms"
click node_prisma "https://github.com/kiarie-ke/sms/blob/main/apps/api/src/prisma/prisma.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_role_ui,node_login_ui,node_web_session,node_web_api,node_user toneBlue
class node_auth_controller,node_auth_service,node_auth_cookie toneAmber
class node_students,node_student_routes,node_photo_storage,node_scoping,node_school_structure toneMint
class node_attendance,node_exams,node_cbc,node_report_cards,node_fees,node_notifications,node_audit,node_sms toneRose
class node_prisma,node_postgres,node_cloudinary toneIndigo
```

## Components

### Web experience

- [Role dashboards](https://github.com/kiarie-ke/sms/tree/main/apps/web/src/app/(dashboard)): `apps/web/src/app/(dashboard)`
- [Login form](https://github.com/kiarie-ke/sms/blob/main/apps/web/src/components/auth/login-form.tsx): `apps/web/src/components/auth/login-form.tsx`
- [Session routes](https://github.com/kiarie-ke/sms/tree/main/apps/web/src/app/api/session): `apps/web/src/app/api/session`
- [API client](https://github.com/kiarie-ke/sms/blob/main/apps/web/src/lib/api/http-client.ts): `apps/web/src/lib/api/http-client.ts`

### Identity and access

- [Auth endpoints](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/auth/auth.controller.ts): `apps/api/src/auth/auth.controller.ts`
- [Authentication](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/auth/auth.service.ts): `apps/api/src/auth/auth.service.ts`
- [Auth cookies](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/auth/auth-cookie.service.ts): `apps/api/src/auth/auth-cookie.service.ts`

### People and structure

- [Student management](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/people/students/students.service.ts): `apps/api/src/people/students/students.service.ts`
- [Student endpoints](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/people/students/students.controller.ts): `apps/api/src/people/students/students.controller.ts`
- [Photo storage](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/people/students/photo-storage.service.ts): `apps/api/src/people/students/photo-storage.service.ts`
- [Role scoping](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/scoping/scoping.service.ts): `apps/api/src/scoping/scoping.service.ts`
- [School structure](https://github.com/kiarie-ke/sms/tree/main/apps/api/src/structure): `apps/api/src/structure`

### School operations

- [Attendance](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/attendance/attendance.service.ts): `apps/api/src/attendance/attendance.service.ts`
- [Exams and marks](https://github.com/kiarie-ke/sms/tree/main/apps/api/src/exams): `apps/api/src/exams`
- [CBC assessment](https://github.com/kiarie-ke/sms/tree/main/apps/api/src/cbc): `apps/api/src/cbc`
- [Report cards](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/report-cards/report-card.service.ts): `apps/api/src/report-cards/report-card.service.ts`
- [Fees](https://github.com/kiarie-ke/sms/tree/main/apps/api/src/fees): `apps/api/src/fees`
- [Notifications](https://github.com/kiarie-ke/sms/tree/main/apps/api/src/notifications): `apps/api/src/notifications`
- [Audit logs](https://github.com/kiarie-ke/sms/tree/main/apps/api/src/audit): `apps/api/src/audit`
- [SMS integration](https://github.com/kiarie-ke/sms/tree/main/apps/api/src/sms): `apps/api/src/sms`

### Persistence

- [Prisma access](https://github.com/kiarie-ke/sms/blob/main/apps/api/src/prisma/prisma.service.ts): `apps/api/src/prisma/prisma.service.ts`
- **PostgreSQL**

### Other components

- **School user**
- **Cloudinary**

## Connections

- School user → Login form: signs in (evidence: `README.md`)
- Login form → Session routes: starts session (evidence: `README.md`)
- Session routes → Auth endpoints: authenticates (evidence: `README.md`)
- Auth endpoints → Authentication: delegates to (evidence: `apps/api/src/auth/auth.controller.ts`)
- Auth endpoints → Auth cookies: sets cookies (evidence: `apps/api/src/auth/auth.controller.ts`)
- School user → Role dashboards: uses role view (evidence: `README.md`)
- Role dashboards → API client: requests records (evidence: `README.md`)
- API client → Student endpoints: calls API (evidence: `README.md`)
- Student endpoints → Student management: delegates to (evidence: `apps/api/src/people/students/students.controller.ts`)
- Student management → Role scoping: checks access (evidence: `README.md`)
- Student endpoints → Photo storage: uploads photo (evidence: `README.md`)
- Photo storage → Cloudinary: uploads image (evidence: `apps/api/src/people/students/photo-storage.service.ts`)
- School user → Attendance: records or views (evidence: `README.md`)
- Attendance → Role scoping: enforces scope (evidence: `README.md`)
- Attendance → Notifications: notifies absence (evidence: `README.md`)
- Student management → Prisma access: persists records
- Attendance → Prisma access: reads and writes
- Prisma access → PostgreSQL: stores data (evidence: `README.md`)
- School structure → Prisma access: persists structure
- Exams and marks → Prisma access: stores exam data (evidence: `apps/api/src/exams/exam.repository.ts`)
- CBC assessment → Prisma access: stores assessment data (evidence: `apps/api/src/cbc/cbc.repository.ts`)
- Report cards → Exams and marks: uses exam marks (evidence: `apps/api/src/report-cards/report-card.service.ts`)
- Report cards → CBC assessment: uses CBC results (evidence: `apps/api/src/report-cards/report-card.service.ts`)
- Fees → Prisma access: stores fee data (evidence: `apps/api/src/fees/fee.repository.ts`)
- Audit logs → Prisma access: stores audit data
- SMS integration → School user: sends messages
