How achrafmz/quiz-backend works
Project type and purpose
• This is a monolithic, REST-style backend service for a mobile/web quiz application (“QuizEdu Backend”), built with Spring Boot.
• It exposes CRUD APIs for users, categories, quizzes, questions, options, and administrative/statistics endpoints.
• Auth is via JWT. Persistence is in a MySQL database through Spring Data JPA.
File structure
• Top level:
• Dockerfile, azure-pipelines.yml, pom.xml – build, CI/CD, containerization.
• /src/main/java/com/quiz/quiz:
– /Controllers (presentation layer, REST endpoints)
– /services (business logic)
– /repositories (data access via JPA)
– /models (domain entities: Quiz, Question, Option, Category)
– QuizApplication.java (Spring Boot entry point)
• /src/main/resources/application.properties – DB & JWT config
• /src/test – end-to-end and unit tests
• Pattern: classic layered architecture (Controller → Service → Repository → Database).
README for additional insights
• Lists user flows (registration, login, taking quizzes) and admin flows (CRUD + statistics).
• Tech stack: Java, Spring Boot, MySQL, Spring Data JPA, JWT.
Elements
• Clear labels: e.g., “QuizController”, “QuestionService”, “QuizRepository”, “MySQL DB”.
• Client → Controllers (HTTP)
• Controllers → Services (method calls)
• Services → Repositories (CRUD operations)
• Repositories → MySQL (SQL queries)
• CI/CD → Docker → Deployment environment
• Rectangles for code modules (Controllers, Services, Repositories)
Summary
• Component with its technology (e.g., “Spring Data JPA repository”).