# yakuzatin3-boop/school-management-api architecture

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

- Interactive diagram: https://gitdiagram.com/yakuzatin3-boop/school-management-api
- Repository: https://github.com/yakuzatin3-boop/school-management-api

## Overview

This repository is a NestJS REST API for school administration, backed by TypeORM and PostgreSQL. The main user workflow is an authenticated administrator or teacher managing classes and student enrollments; students and staff also access academic records and learning activities. Domain areas include identity and access, school structure, enrollment, coursework, and communication/records. The controller-to-service links below are supported by the sampled controller excerpts or SOURCE INDEX references. Other documented capabilities are represented as domain components, but their internal calls were not sampled.

Main entry points: [`src/auth/auth.service.ts`](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/auth/auth.service.ts) (Authentication), [`src/classes/classes.service.ts`](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/classes/classes.service.ts) (Classes & schedules), [`src/enrollments/enrollments.service.ts`](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/enrollments/enrollments.service.ts) (Enrollments), [`src/users/users.service.ts`](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/users/users.service.ts) (User accounts)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_identity["Identity &amp; access"]
  node_auth_api["Authentication<br/>[auth.service.ts]"]
  node_user_accounts["User accounts<br/>[users.service.ts]"]
  node_access_control["JWT &amp; roles<br/>[roles.guard.ts]"]
  node_teachers["Teacher profiles"]
end

subgraph group_school["School structure"]
  node_classes["Classes &amp; schedules<br/>[classes.service.ts]"]
  node_buildings["Buildings &amp; rooms"]
  node_courses["Courses<br/>[courses.service.ts]"]
  node_class_registration["Class registration"]
  node_enrollments["Enrollments"]
  node_school_rules["School rules"]
end

subgraph group_learning["Learning workflow"]
  node_lessons["Lessons<br/>[lessons.service.ts]"]
  node_assignments["Assignments"]
  node_submissions["Submissions"]
  node_exams["Exam attempts<br/>[exams.service.ts]"]
end

subgraph group_community["Communication"]
  node_groups["Student groups<br/>[groups.service.ts]"]
  node_announcements["Announcements"]
  node_notifications["Notifications"]
end

subgraph group_records["Student records"]
  node_students["Student profiles"]
  node_attendance["Attendance"]
  node_grading["Scores &amp; scales<br/>[grading.service.ts]"]
  node_certificates["Certificates"]
  node_audit["Audit logs<br/>[audit.service.ts]"]
end

node_school_user(("School user"))
node_postgres[("PostgreSQL")]

node_school_user -->|"signs in"| node_auth_api
node_school_user -->|"manages classes"| node_classes
node_classes -->|"manages students"| node_enrollments
node_school_user -->|"manages enrollment"| node_enrollments
node_school_user -->|"views records"| node_students
node_school_user -->|"manages work"| node_assignments
node_auth_api -->|"uses accounts"| node_user_accounts
node_classes -->|"persists school data"| node_postgres
node_enrollments -->|"persists enrollment"| node_postgres
node_auth_api -->|"persists tokens"| node_postgres

click node_auth_api "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/auth/auth.service.ts"
click node_user_accounts "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/users/users.service.ts"
click node_access_control "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/common/guards/roles.guard.ts"
click node_teachers "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/teachers/teachers.service.ts"
click node_classes "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/classes/classes.service.ts"
click node_buildings "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/classes/buildings/buildings.service.ts"
click node_courses "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/courses/courses.service.ts"
click node_class_registration "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/class-registration/class-registration.service.ts"
click node_enrollments "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/enrollments/enrollments.service.ts"
click node_students "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/students/students.service.ts"
click node_attendance "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/attendance/attendance.service.ts"
click node_grading "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/grading/grading.service.ts"
click node_certificates "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/certificates/certificates.service.ts"
click node_audit "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/audit/audit.service.ts"
click node_lessons "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/lessons/lessons.service.ts"
click node_assignments "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/assignments/assignments.service.ts"
click node_submissions "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/submissions/submissions.service.ts"
click node_exams "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/exams/exams.service.ts"
click node_groups "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/groups/groups.service.ts"
click node_announcements "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/announcements/announcements.service.ts"
click node_notifications "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/notifications/notifications.service.ts"
click node_school_rules "https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/school-rules/school-rules.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_auth_api,node_user_accounts,node_access_control,node_teachers,node_school_user toneBlue
class node_classes,node_buildings,node_courses,node_class_registration,node_enrollments,node_school_rules,node_postgres toneAmber
class node_lessons,node_assignments,node_submissions,node_exams toneMint
class node_groups,node_announcements,node_notifications toneRose
class node_students,node_attendance,node_grading,node_certificates,node_audit toneIndigo
```

## Components

### Identity & access

- [Authentication](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/auth/auth.service.ts): `src/auth/auth.service.ts`
- [User accounts](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/users/users.service.ts): `src/users/users.service.ts`
- [JWT & roles](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/common/guards/roles.guard.ts): `src/common/guards/roles.guard.ts`
- [Teacher profiles](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/teachers/teachers.service.ts): `src/teachers/teachers.service.ts`

### School structure

- [Classes & schedules](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/classes/classes.service.ts): `src/classes/classes.service.ts`
- [Buildings & rooms](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/classes/buildings/buildings.service.ts): `src/classes/buildings/buildings.service.ts`
- [Courses](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/courses/courses.service.ts): `src/courses/courses.service.ts`
- [Class registration](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/class-registration/class-registration.service.ts): `src/class-registration/class-registration.service.ts`
- [Enrollments](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/enrollments/enrollments.service.ts): `src/enrollments/enrollments.service.ts`
- [School rules](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/school-rules/school-rules.service.ts): `src/school-rules/school-rules.service.ts`

### Learning workflow

- [Lessons](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/lessons/lessons.service.ts): `src/lessons/lessons.service.ts`
- [Assignments](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/assignments/assignments.service.ts): `src/assignments/assignments.service.ts`
- [Submissions](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/submissions/submissions.service.ts): `src/submissions/submissions.service.ts`
- [Exam attempts](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/exams/exams.service.ts): `src/exams/exams.service.ts`

### Communication

- [Student groups](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/groups/groups.service.ts): `src/groups/groups.service.ts`
- [Announcements](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/announcements/announcements.service.ts): `src/announcements/announcements.service.ts`
- [Notifications](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/notifications/notifications.service.ts): `src/notifications/notifications.service.ts`

### Student records

- [Student profiles](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/students/students.service.ts): `src/students/students.service.ts`
- [Attendance](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/attendance/attendance.service.ts): `src/attendance/attendance.service.ts`
- [Scores & scales](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/grading/grading.service.ts): `src/grading/grading.service.ts`
- [Certificates](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/certificates/certificates.service.ts): `src/certificates/certificates.service.ts`
- [Audit logs](https://github.com/yakuzatin3-boop/school-management-api/blob/master/src/audit/audit.service.ts): `src/audit/audit.service.ts`

### Other components

- **School user**
- **PostgreSQL**

## Connections

- School user → Authentication: signs in (evidence: `README.md`)
- School user → Classes & schedules: manages classes
- Classes & schedules → Enrollments: manages students
- School user → Enrollments: manages enrollment
- School user → Student profiles: views records
- School user → Assignments: manages work
- Authentication → User accounts: uses accounts (evidence: `src/auth/auth.service.ts`)
- Classes & schedules → PostgreSQL: persists school data (evidence: `README.md`)
- Enrollments → PostgreSQL: persists enrollment (evidence: `README.md`)
- Authentication → PostgreSQL: persists tokens (evidence: `README.md`)
