# mohamednasr18/school-management-api architecture

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

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

## Overview

This is a school-management product: staff sign in, then review or manage teachers, classes, and students, or upload CSV files and inspect an import report. The React pages call a shared API client; NestJS controllers dispatch to domain services, which use Prisma for persistence. The README documents role enforcement and CSV processing, including a CLI entry point. Some backend modules and frontend pages are unsampled, so their connections are included only where the source index or README supports them.

Main entry points: [`Frontend/src/api.js`](https://github.com/mohamednasr18/school-management-api/blob/main/Frontend/src/api.js) (API client), [`Backend/src/prisma/prisma.service.ts`](https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/prisma/prisma.service.ts) (Prisma database client), [`Backend/src/common/guards`](https://github.com/mohamednasr18/school-management-api/tree/main/Backend/src/common/guards) (JWT and role guards), [`Frontend/src/App.jsx`](https://github.com/mohamednasr18/school-management-api/blob/main/Frontend/src/App.jsx) (Page routing)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["React interface"]
  node_routes["Page routing<br/>[App.jsx]"]
  node_authui["Session context<br/>[auth.jsx]"]
  node_pages["Management pages"]
  node_importpage["Import page<br/>[Import.jsx]"]
  node_apiclient["API client<br/>[api.js]"]
end

subgraph group_backend["API and access"]
  node_logincontroller["Login endpoint<br/>[auth.controller.ts]"]
  node_authservice["Credential and token service<br/>[auth.service.ts]"]
  node_access["JWT and role guards"]
  node_prisma["Prisma database client<br/>[prisma.service.ts]"]
end

subgraph group_school["School records"]
  node_teachers["Teacher management"]
  node_classes["Class management"]
  node_students["Student management"]
end

subgraph group_importdata["CSV import and storage"]
  node_importcontroller["Import endpoint"]
  node_importservice["CSV validation and reporting<br/>[import.service.ts]"]
  node_importcli["CSV command-line entry<br/>[import.cli.ts]"]
end

node_user(("School user"))
node_database[("PostgreSQL")]

node_user -->|"uses"| node_routes
node_routes -->|"checks session"| node_authui
node_routes -->|"routes to"| node_pages
node_pages -->|"requests data"| node_apiclient
node_importpage -->|"uploads files"| node_apiclient
node_authui -->|"logs in via"| node_apiclient
node_apiclient -->|"posts login"| node_logincontroller
node_logincontroller -->|"delegates to"| node_authservice
node_authservice -->|"looks up user"| node_prisma
node_authservice -->|"returns token"| node_user
node_apiclient -->|"calls API"| node_teachers
node_apiclient -->|"calls API"| node_classes
node_apiclient -->|"calls API"| node_students
node_apiclient -->|"posts import"| node_importcontroller
node_teachers -->|"queries records"| node_prisma
node_classes -->|"queries records"| node_prisma
node_students -->|"queries records"| node_prisma
node_importcontroller -->|"delegates to"| node_importservice
node_importservice -->|"writes records"| node_prisma
node_importcli -->|"shares processing"| node_importservice
node_prisma -->|"connects to"| node_database
node_access -->|"protects endpoints"| node_teachers
node_access -->|"protects endpoints"| node_classes
node_access -->|"protects endpoints"| node_students
node_access -->|"admin-only access"| node_importcontroller

click node_routes "https://github.com/mohamednasr18/school-management-api/blob/main/Frontend/src/App.jsx"
click node_authui "https://github.com/mohamednasr18/school-management-api/blob/main/Frontend/src/auth.jsx"
click node_pages "https://github.com/mohamednasr18/school-management-api/tree/main/Frontend/src/pages"
click node_importpage "https://github.com/mohamednasr18/school-management-api/blob/main/Frontend/src/pages/Import.jsx"
click node_apiclient "https://github.com/mohamednasr18/school-management-api/blob/main/Frontend/src/api.js"
click node_logincontroller "https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/auth/auth.controller.ts"
click node_authservice "https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/auth/auth.service.ts"
click node_access "https://github.com/mohamednasr18/school-management-api/tree/main/Backend/src/common/guards"
click node_teachers "https://github.com/mohamednasr18/school-management-api/tree/main/Backend/src/teachers"
click node_classes "https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/classes/classes.controller.ts"
click node_students "https://github.com/mohamednasr18/school-management-api/tree/main/Backend/src/students"
click node_importcontroller "https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/import/import.controller.ts"
click node_importservice "https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/import/import.service.ts"
click node_importcli "https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/import/import.cli.ts"
click node_prisma "https://github.com/mohamednasr18/school-management-api/blob/main/Backend/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_routes,node_authui,node_pages,node_importpage,node_apiclient,node_user toneBlue
class node_logincontroller,node_authservice,node_access,node_prisma,node_database toneAmber
class node_teachers,node_classes,node_students toneMint
class node_importcontroller,node_importservice,node_importcli toneRose
```

## Components

### React interface

- [Page routing](https://github.com/mohamednasr18/school-management-api/blob/main/Frontend/src/App.jsx): `Frontend/src/App.jsx`
- [Session context](https://github.com/mohamednasr18/school-management-api/blob/main/Frontend/src/auth.jsx): `Frontend/src/auth.jsx`
- [Management pages](https://github.com/mohamednasr18/school-management-api/tree/main/Frontend/src/pages): `Frontend/src/pages`
- [Import page](https://github.com/mohamednasr18/school-management-api/blob/main/Frontend/src/pages/Import.jsx): `Frontend/src/pages/Import.jsx`
- [API client](https://github.com/mohamednasr18/school-management-api/blob/main/Frontend/src/api.js): `Frontend/src/api.js`

### API and access

- [Login endpoint](https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/auth/auth.controller.ts): `Backend/src/auth/auth.controller.ts`
- [Credential and token service](https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/auth/auth.service.ts): `Backend/src/auth/auth.service.ts`
- [JWT and role guards](https://github.com/mohamednasr18/school-management-api/tree/main/Backend/src/common/guards): `Backend/src/common/guards`
- [Prisma database client](https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/prisma/prisma.service.ts): `Backend/src/prisma/prisma.service.ts`

### School records

- [Teacher management](https://github.com/mohamednasr18/school-management-api/tree/main/Backend/src/teachers): `Backend/src/teachers`
- [Class management](https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/classes/classes.controller.ts): `Backend/src/classes/classes.controller.ts`
- [Student management](https://github.com/mohamednasr18/school-management-api/tree/main/Backend/src/students): `Backend/src/students`

### CSV import and storage

- [Import endpoint](https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/import/import.controller.ts): `Backend/src/import/import.controller.ts`
- [CSV validation and reporting](https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/import/import.service.ts): `Backend/src/import/import.service.ts`
- [CSV command-line entry](https://github.com/mohamednasr18/school-management-api/blob/main/Backend/src/import/import.cli.ts): `Backend/src/import/import.cli.ts`

### Other components

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

## Connections

- School user → Page routing: uses
- Page routing → Session context: checks session (evidence: `Frontend/src/App.jsx`)
- Page routing → Management pages: routes to (evidence: `Frontend/src/App.jsx`)
- Management pages → API client: requests data (evidence: `Frontend/src/pages/Students.jsx`)
- Import page → API client: uploads files (evidence: `Frontend/src/api.js`)
- Session context → API client: logs in via (evidence: `Frontend/src/auth.jsx`)
- API client → Login endpoint: posts login (evidence: `Frontend/src/api.js`)
- Login endpoint → Credential and token service: delegates to (evidence: `Backend/src/auth/auth.controller.ts`)
- Credential and token service → Prisma database client: looks up user (evidence: `Backend/src/auth/auth.service.ts`)
- Credential and token service → School user: returns token (evidence: `Backend/src/auth/auth.service.ts`)
- API client → Teacher management: calls API (evidence: `Frontend/src/api.js`)
- API client → Class management: calls API (evidence: `Frontend/src/api.js`)
- API client → Student management: calls API (evidence: `Frontend/src/api.js`)
- API client → Import endpoint: posts import (evidence: `Frontend/src/api.js`)
- Teacher management → Prisma database client: queries records (evidence: `Backend/src/teachers/teachers.service.ts`)
- Class management → Prisma database client: queries records
- Student management → Prisma database client: queries records (evidence: `Backend/src/students/students.service.ts`)
- Import endpoint → CSV validation and reporting: delegates to (evidence: `Backend/src/import/import.controller.ts`)
- CSV validation and reporting → Prisma database client: writes records (evidence: `Backend/src/import/import.service.ts`)
- CSV command-line entry → CSV validation and reporting: shares processing (evidence: `README.md`)
- Prisma database client → PostgreSQL: connects to (evidence: `Backend/src/prisma/prisma.service.ts`)
- JWT and role guards → Teacher management: protects endpoints (evidence: `README.md`)
- JWT and role guards → Class management: protects endpoints (evidence: `README.md`)
- JWT and role guards → Student management: protects endpoints (evidence: `README.md`)
- JWT and role guards → Import endpoint: admin-only access (evidence: `README.md`)
