How niwas-kumar/ai-learning-disorder works
Project type and purpose
• This is a Spring Boot 3.x REST-API backend (Java 17) for early detection of learning disorders in students.
• Teachers register students, record quizzes and handwriting samples, and review AI-based risk predictions.
File structure
Top-level within ai-learning-disorder/
• pom.xml, Maven wrapper & .mvn/: Maven build system
• src/main/java/com/learningdetector/aild/
– controller/: REST endpoints (QuestionController, QuizController, StudentController, TeacherController)
– dto/: request/response payloads
– entity/: JPA entities (Student, Teacher, Quiz, Question, QuizAttempt, Prediction)
– helpers/: utility classes (ExcelHelper for batch imports)
– repositories/: Spring Data JPA repositories (DAO layer)
– AiLearningDisorderApplication.java: Spring Boot main class
• src/main/resources/application.properties: DB configuration
• test/: basic Spring Boot startup test
README for additional insights
• Tech stack: Spring Boot + Spring Data JPA + Hibernate + MySQL
• No current service layer, but controllers encapsulate both routing and business logic
• Future: Python-based ML integration, JWT authentication, frontend dashboard
a. Main components
1. API Layer: Spring Boot application
• Controllers (REST endpoints)
• DTOs (payload definitions)
2. Business Logic Layer (implicit)
3. Data Access Layer
• Spring Data JPA repositories
4. Persistence
• MySQL database
• Entities mapped via Hibernate
5. Utilities
• ExcelHelper for quiz import
6. (Future) AI/ML Service
• Python microservice for risk prediction
7. (Future) Authentication Service
• JWT provider
8. (Future) Frontend
• React/Angular/Thymeleaf dashboard
b. Relationships and interactions
• Client → HTTP → Controllers
• Controllers → DTO mapping → Entities / Helpers
• Controllers → Repositories → MySQL
• ExcelHelper invoked by controllers to parse/upload spreadsheets → Entities → Repositories
• (Future) Controllers → REST call → ML Service → Prediction DTO → Persistence
• (Future) Frontend → consumes API endpoints (students, teachers, quizzes, predictions)
c. Architectural patterns / design principles
• Layered (Controller → Service/Helpers → Repository → DB)
• Convention-over-configuration (Spring Boot auto-wiring)
• DTOs to decouple API from persistence
• Repository pattern (Spring Data JPA)
• Utility component for file processing (ExcelHelper)
d. Key technologies/frameworks
• Spring Boot (REST API, dependency injection)
• Spring Data JPA + Hibernate (ORM)
• MySQL (relational DB)
• Lombok (entity/DTO boilerplate)
• Maven (build)
• Future: Python Flask/FastAPI (ML), JWT library, React/Angular