How kankan222/lms works
This repository implements a school and institution management platform: a backend API and scheduled jobs support administrative software, a mobile app, and public institution websites. Users authenticate or browse public pages, then access school operations such as attendance, exams, fees, messaging, and reports. The graph preserves those major product areas while detailing the evidenced authentication, announcement, and job flows. Many domain implementations and client API calls were not excerpted, so their internal connections are omitted rather than inferred.
Main entry points: app.js API gateway · auth.service.js Authentication · query.js SQL database · App.tsx Mobile app
Components 25
User applications
- Mobile app
frontend/mobile/App.tsx - Mobile services
frontend/mobile/src/services/api.ts - Admin software
frontend/software/src/App.jsx - Admin routing
frontend/software/src/routes/AppRoutes.jsx - Institution website
frontend/website/src/app/AppRoutes.jsx - SEO metadata
frontend/website/src/app/SeoManager.jsx
API and access
- API gateway
backend/app.js - Authentication
backend/modules/auth/auth.service.js - Permission checks
backend/core/rbac/rbac.middleware.js
School operations
- Academic records
backend/modules/academic - Student records
backend/modules/students/student.service.js - Teacher records
backend/modules/teachers/teacher.service.js - Attendance
backend/modules/attendance - Exams and marks
backend/modules/marks/marks.service.js - Fees and transport
backend/modules/fees/fee.service.js - Class routines
backend/modules/routines/routines.service.js - Reports and dashboards
backend/modules/reports
Communication
- Announcements
backend/modules/announcements/announcements.service.js - Messaging and media
backend/modules/messaging - Notifications
backend/modules/notifications
Data and jobs
- SQL database
backend/core/db/query.js - Scheduled jobs
backend/jobs/cronWorker.js - Message object storage
backend/modules/messaging/messaging.storage.js
Other components
- School staff
- Families
Connections 26
- School staff → Mobile app: uses
- Families → Mobile app: uses
- School staff → Admin software: uses
- Mobile app → Mobile services: uses API
- Admin software → Admin routing: renders
frontend/software/src/App.jsx - Admin routing → Authentication: routes login
- Institution website → SEO metadata: renders
frontend/website/src/app/AppRoutes.jsx - API gateway → Authentication: mounts routes
backend/app.js - API gateway → Academic records: mounts routes
backend/app.js - API gateway → Student records: mounts routes
backend/app.js - API gateway → Attendance: mounts routes
backend/app.js - API gateway → Exams and marks: mounts routes
backend/app.js - API gateway → Fees and transport: mounts routes
backend/app.js - API gateway → Class routines: mounts routes
backend/app.js - API gateway → Reports and dashboards: mounts routes
backend/app.js - API gateway → Announcements: mounts routes
backend/app.js - API gateway → Messaging and media: mounts routes
backend/app.js - API gateway → Notifications: mounts routes
backend/app.js - API gateway → Permission checks: attaches permissions
backend/app.js - Authentication → SQL database: queries users
- Authentication → Permission checks: loads roles
backend/modules/auth/auth.service.js - Permission checks → SQL database: loads permissions
- Announcements → SQL database: persists data
- Scheduled jobs → Announcements: starts publishing
backend/jobs/cronWorker.js - Scheduled jobs → SQL database: checks connection
backend/jobs/cronWorker.js - Messaging and media → Message object storage: stores media