How aaramvatech/aaramva-sikshya works
Aaramva Shikshya is a multi-tenant school-management platform for Nepali schools, with web and mobile experiences backed by a NestJS API. Users authenticate within a school tenant, then carry out student, academic, attendance, examination, finance, and administration tasks; the API scopes school data and returns results to the clients. The README documents additional HR, library, reporting, and communication capabilities. The map follows documented product boundaries and sampled controller/service calls; unsampled modules are represented at their enclosing directory level, so uncertain internal wiring is omitted.
Main entry points: tenant-prisma.service.ts Tenant database · app.module.ts REST API · layout.tsx Web portal · _layout.tsx Mobile apps
Components 20
User clients
- Web portal
apps/web/app/(portal)/layout.tsx - Mobile apps
apps/mobile/app/_layout.tsx
Tenant platform
- REST API
apps/api/src/app.module.ts - Authentication
apps/api/src/modules/auth - Tenant isolation
apps/api/src/modules/tenant - Tenant database
apps/api/src/modules/tenant/tenant-prisma.service.ts
School operations
- Student records
apps/api/src/modules/student - Academics
apps/api/src/modules/academic - Attendance
apps/api/src/modules/attendance - Examinations
apps/api/src/modules/examination - HR and library
apps/api/src/modules/hr - Reports and dashboard
apps/api/src/modules/reports - Communication
apps/api/src/modules/communication
Finance services
- Fee billing
apps/api/src/modules/finance - Payment gateways
apps/api/src/modules/finance
Administration
- Platform administration
apps/api/src/modules/super-admin - School onboarding
apps/api/src/modules/onboarding
Other components
- School users
- Sparrow SMS
- Object storage
Connections 22
- School users → Web portal: use portal
- School users → Mobile apps: use apps
- Web portal → REST API: send requests
- Mobile apps → REST API: send requests
- REST API → Authentication: dispatches auth
- REST API → Tenant isolation: resolves tenant
- Tenant isolation → Tenant database: sets scope
- Authentication → Tenant database: reads and writes
- Student records → Tenant database: reads and writes
- Academics → Tenant database: reads and writes
- Attendance → Tenant database: reads and writes
- Examinations → Tenant database: reads and writes
- HR and library → Tenant database: reads and writes
- Reports and dashboard → Tenant database: reads
- Fee billing → Tenant database: reads and writes
- Fee billing → Payment gateways: handles payments
- Communication → Sparrow SMS: sends SMS
- REST API → Object storage: presigns file access
- Platform administration → School onboarding: onboards schools
- Platform administration → Tenant database: manages tenants
- REST API → Web portal: returns results
- REST API → Mobile apps: returns results