# achrafmz/quiz-backend architecture

> Architecture diagram of the GitHub repository achrafmz/quiz-backend, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/achrafmz/quiz-backend
- Repository: https://github.com/achrafmz/quiz-backend

## Overview

##### 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”).

## Diagram (Mermaid)

```mermaid
graph TB
    %% Client Layer
    Client["Web & Mobile Clients"]:::client

    %% API Layer
    subgraph "API Layer"
        QCtrl["QuizController"]:::controller
        QCtl2["QuestionController"]:::controller
        OCtrl["OptionController"]:::controller
        CatCtrl["CategorieController"]:::controller
    end

    %% Business Layer
    subgraph "Business Layer"
        QSvc["QuizService"]:::service
        QSvc2["QuestionService"]:::service
        OSvc["OptionService"]:::service
        CatSvc["CategorieService"]:::service
    end

    %% Data Layer
    subgraph "Data Layer"
        QRepo["QuizRepository"]:::repository
        QRepo2["QuestionRepository"]:::repository
        ORepo["OptionRepository"]:::repository
        CatRepo["CategorieRepository"]:::repository
        MySQLDB["MySQL Database"]:::database
    end

    %% Infrastructure
    subgraph "Infrastructure & CI/CD"
        Pipeline["azure-pipelines.yml"]:::infra
        Docker["Dockerfile"]:::infra
        Deployment["Deployment Environment"]:::infra
    end

    %% Auth Service
    Auth["JWT Authentication Service"]:::infra

    %% Connections
    Client -->|"HTTP Requests"| QCtrl
    Client -->|"HTTP Requests"| QCtl2
    Client -->|"HTTP Requests"| OCtrl
    Client -->|"HTTP Requests"| CatCtrl

    QCtrl -->|"calls"| QSvc
    QCtl2 -->|"calls"| QSvc2
    OCtrl -->|"calls"| OSvc
    CatCtrl -->|"calls"| CatSvc

    QSvc -->|"CRUD ops"| QRepo
    QSvc2 -->|"CRUD ops"| QRepo2
    OSvc -->|"CRUD ops"| ORepo
    CatSvc -->|"CRUD ops"| CatRepo

    QRepo -->|"SQL Queries"| MySQLDB
    QRepo2 -->|"SQL Queries"| MySQLDB
    ORepo -->|"SQL Queries"| MySQLDB
    CatRepo -->|"SQL Queries"| MySQLDB

    QCtrl -- "authentication" --> Auth
    QCtl2 -- "authentication" --> Auth
    OCtrl -- "authentication" --> Auth
    CatCtrl -- "authentication" --> Auth

    Pipeline -->|"build image"| Docker
    Docker -->|"deploy"| Deployment

    %% Click Events
    click QCtrl "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/Controllers/QuizController.java"
    click QCtl2 "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/Controllers/QuestionController.java"
    click OCtrl "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/Controllers/OptionController.java"
    click CatCtrl "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/Controllers/CategorieController.java"
    click QSvc "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/services/QuizService.java"
    click QSvc2 "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/services/QuestionService.java"
    click OSvc "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/services/OptionService.java"
    click CatSvc "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/services/CategorieService.java"
    click QRepo "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/repositories/QuizRepository.java"
    click QRepo2 "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/repositories/QuestionRepository.java"
    click ORepo "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/repositories/OptionRepository.java"
    click CatRepo "https://github.com/achrafmz/quiz-backend/blob/master/src/main/java/com/quiz/quiz/repositories/CategorieRepository.java"
    click MySQLDB "https://github.com/achrafmz/quiz-backend/blob/master/src/main/resources/application.properties"
    click Pipeline "https://github.com/achrafmz/quiz-backend/blob/master/azure-pipelines.yml"
    click Docker "https://github.com/achrafmz/quiz-backend/tree/master/Dockerfile"

    %% Styles
    classDef client fill:#fcc,stroke:#333,stroke-width:1px;
    classDef controller fill:#f9f,stroke:#333,stroke-width:1px;
    classDef service fill:#9ff,stroke:#333,stroke-width:1px;
    classDef repository fill:#ff9,stroke:#333,stroke-width:1px;
    classDef database fill:#ccf,stroke:#333,stroke-width:1px,shape:cylinder;
    classDef infra fill:#cfc,stroke:#333,stroke-width:1px;
```
