How mohamednasr18/school-management-api works
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: api.js API client · prisma.service.ts Prisma database client · guards JWT and role guards · App.jsx Page routing
Components 17
React interface
- Page routing
Frontend/src/App.jsx - Session context
Frontend/src/auth.jsx - Management pages
Frontend/src/pages - Import page
Frontend/src/pages/Import.jsx - API client
Frontend/src/api.js
API and access
- Login endpoint
Backend/src/auth/auth.controller.ts - Credential and token service
Backend/src/auth/auth.service.ts - JWT and role guards
Backend/src/common/guards - Prisma database client
Backend/src/prisma/prisma.service.ts
School records
- Teacher management
Backend/src/teachers - Class management
Backend/src/classes/classes.controller.ts - Student management
Backend/src/students
CSV import and storage
- Import endpoint
Backend/src/import/import.controller.ts - CSV validation and reporting
Backend/src/import/import.service.ts - CSV command-line entry
Backend/src/import/import.cli.ts
Other components
- School user
- PostgreSQL
Connections 25
- School user → Page routing: uses
- Page routing → Session context: checks session
Frontend/src/App.jsx - Page routing → Management pages: routes to
Frontend/src/App.jsx - Management pages → API client: requests data
Frontend/src/pages/Students.jsx - Import page → API client: uploads files
Frontend/src/api.js - Session context → API client: logs in via
Frontend/src/auth.jsx - API client → Login endpoint: posts login
Frontend/src/api.js - Login endpoint → Credential and token service: delegates to
Backend/src/auth/auth.controller.ts - Credential and token service → Prisma database client: looks up user
Backend/src/auth/auth.service.ts - Credential and token service → School user: returns token
Backend/src/auth/auth.service.ts - API client → Teacher management: calls API
Frontend/src/api.js - API client → Class management: calls API
Frontend/src/api.js - API client → Student management: calls API
Frontend/src/api.js - API client → Import endpoint: posts import
Frontend/src/api.js - Teacher management → Prisma database client: queries records
Backend/src/teachers/teachers.service.ts - Class management → Prisma database client: queries records
- Student management → Prisma database client: queries records
Backend/src/students/students.service.ts - Import endpoint → CSV validation and reporting: delegates to
Backend/src/import/import.controller.ts - CSV validation and reporting → Prisma database client: writes records
Backend/src/import/import.service.ts - CSV command-line entry → CSV validation and reporting: shares processing
README.md - Prisma database client → PostgreSQL: connects to
Backend/src/prisma/prisma.service.ts - JWT and role guards → Teacher management: protects endpoints
README.md - JWT and role guards → Class management: protects endpoints
README.md - JWT and role guards → Student management: protects endpoints
README.md - JWT and role guards → Import endpoint: admin-only access
README.md