A modern, scalable, NestJS powered backend system designed for schools to manage students, teachers, classes, attendance, results, timetables, and financial operations (fees, invoices, payments). Built for performance, multi-tenant usage, and clean developer experience.

• RBAC Authentication (Admin, Teacher, Student)
• User & School Management
• Classes & Subjects Management
• Student Enrollment
• Attendance Tracking
• Results & Grades Module
• Timetable Scheduling
• Fees, Invoices, and Payments
• Audit Logging

The backend is built in a modular monorepo structure to keep each domain clean and independently maintainable.

/apps
  /api              → Main backend API (NestJS)

/packages
  /core             → Shared utilities (DTOs, Guards, Pipes)
  /database         → TypeORM schema & migrations
  /types            → Global TypeScript types
  /auth             → Authentication logic

• API Layer (REST + JWT Auth)
• Modular domain architecture
• Redis caching
• Centralized Audit Logging

• JWT Authentication
• Login, Signup
• Role-based access control
• Guards (AdminGuard, TeacherGuard, StudentGuard)

• Create/Update users
• Assign roles
• Manage teacher profiles
• Manage student information (parents, classes)

• Create classes
• Assign a teacher
• Manage capacity
• Create subjects

• Enroll students into classes
• Track academic year
• View all students in a class

• Check-in / Check-out system
• Daily logs
• Attendance reports

• Record scores
• Compute grades
• View term results per student

• Schedule classes
• Manage periods and days
• Class + subject linking

• Generate invoices
• Track due dates
• Log payments
• Financial reporting

• Records every admin or teacher action
• Stores IP address & timestamp
• Useful for compliance & debugging

• Node.js + NestJS
• TypeScript
• TypeORM
• PostgreSQL
• Redis (optional)

• Docker-ready
• CI/CD adaptable
• Monorepo-friendly

• Node.js (v18 or higher)
• PostgreSQL (v14 or higher)
• npm or yarn

npm install

Create a .env file in the root directory:

DATABASE_URL="postgresql://user:password@localhost:5432/school"
JWT_SECRET="your_secret_key_here"
PORT=3000

Development mode:

npm run start:dev

Production mode:

npm run build
npm run start:prod

The API will be available at: http://localhost:3000

# development
npm run start

# watch mode
npm run start:dev

# production mode
npm run start:prod

# unit tests
npm test

# watch mode
npm run test:watch

# e2e tests
npm run test:e2e

# test coverage
npm run test:cov

npm run build

npm run start:prod

This project uses GitHub Actions for continuous integration. The CI pipeline runs on:

• Direct pushes to main branch
• Pull requests targeting main branch

The pipeline includes:

1. Test - Runs unit testson Node.js 18.x and 20.x
2. Format Check - Validates code formatting and linting
3. Build - Compiles the application
4. Start - Verifies the application starts successfully

1. Fork the repo
2. Create a feature branch
3. Submit a PR

• Follow the modular structure
• One module = one domain
• Use DTOs & Validation Pipes
• Write tests

For feature requests, bugs or contributions, open an issue or contact the maintainer.