ramakantrawat/school-analytics-api repository overview

⁠School Analytics API

Production-ready Docker image for the School Analytics Java backend — a Spring Boot REST API for school management (ERP).

It is a drop-in API replacement for the legacy PHP backend: same MySQL schema, JWT auth, and /api/* routes, so existing React web and Capacitor mobile clients work without changes.

⁠Features

• Auth — login, OTP, SSO, branch switch, observer mode
• Platform — schools, branches, features, platform settings
• People — students, teachers, staff attendance, payroll
• Academics — classes, subjects, timetable, exams, assignments
• Operations — attendance, leave, fees, parent accounts
• Facilities — library, transport, events, announcements
• Communications — notifications, chat, WhatsApp, email
• Reports — report cards, attendance reports, ID cards, bulk jobs
• CRM — inquiries, employees, salaries, joins, analytics
• OpenAPI — Swagger UI at /swagger, spec at /api-docs

⁠Requirements

• MySQL database (shared schema with the School Analytics PHP backend)
• Run PHP migrations first — this image does not create database tables (ddl-auto=none)

⁠Quick start

docker pull <your-dockerhub-username>/school-analytics-api:latest

docker run -d \
  --name school-analytics-api \
  -p 8080:8080 \
  -e DB_HOST=your-mysql-host \
  -e DB_PORT=3306 \
  -e DB_NAME=school_erp \
  -e DB_USERNAME=your_user \
  -e DB_PASSWORD=your_password \
  -e JWT_SECRET_KEY=your_jwt_secret \
  -e CRON_KEY=your_cron_secret \
  -v school-uploads:/app/uploads \
  -v school-firebase:/app/firebase \
  <your-dockerhub-username>/school-analytics-api:latest