# houarizegai/quiz-app architecture

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

- Interactive diagram: https://gitdiagram.com/houarizegai/quiz-app
- Repository: https://github.com/houarizegai/quiz-app

## Overview

##### Project type and purpose
- This is a standalone desktop quiz application built with JavaFX.
- Purpose: Allow users to take Java‐based quizzes, fetch questions from a MySQL database, and display results.

##### High‐level file structure analysis
- pom.xml: Maven manages dependencies (JavaFX, JFoenix, FontAwesomeFX, Connector/J).
- src/main/java/com/houarizegai/quizappfx:
- App.java – entry point, starts JavaFX runtime
- controllers/ – JavaFX controllers (UI event handlers)
- dao/db/ – JDBC connection & DAO classes (MysqlConnection, QuestionDao)
- dao/vo/ – Value Objects (QuestionVo) representing data models
- src/main/resources:
- views/ – FXML layout files (About.fxml, JavaQuiz.fxml)
- css/ – style sheets applied to FXML views
- images/ – static assets for UI
- database/quiz_app_db.sql: SQL scripts to build and seed the MySQL quiz database

##### Main architectural components
a. Presentation Layer (JavaFX UI)
- FXML views + CSS styles
- Controllers handle user interactions and UI updates
b. Data Access Layer (DAO)
- MysqlConnection manages JDBC connection to MySQL
- QuestionDao executes SQL queries, maps result sets to QuestionVo
c. Domain Model
- QuestionVo represents quiz questions and answers
d. Database
- MySQL schema defined in quiz_app_db.sql
e. Application Launcher
- App.java initializes the JavaFX Application, loads the primary view

##### Relationships & data flow
1. User clicks a button in the JavaFX UI
2. Controller (e.g., JavaQuizController) receives the event
3. Controller calls QuestionDao via MysqlConnection
4. QuestionDao runs SQL, returns QuestionVo objects
5. Controller updates the UI with question data
6. User submits answer → Controller evaluates, shows results

##### Key architectural patterns & design principles
- Layered architecture: clear separation between UI, controllers, DAO, and database
- MVC-ish: FXML views (V), controllers (C), VO/DAO act as the Model layer
- Dependency injection via FXMLLoader for controllers and CSS for styling
- Single responsibility: each class focuses on one concern (UI logic vs. data access)

##### Technologies & frameworks to annotate
- JavaFX (UI framework)
- JFoenix + FontAwesomeFX (UI component libraries)
- JDBC Connector/J (database connectivity)
- Maven (build & dependency management)
- MySQL (relational database)

- All FXML views (Home, Quiz, About) and their controllers
- DAO classes and connection manager
- QuestionVo as the data contract between layers
- MySQL schema as an external system component
- Maven as the build/dependency layer (optional placement)

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Build & Dependencies"
        direction TB
        Pom["pom.xml"]:::infra
        VBuild["JAR (deployable)"]:::infra
    end

    App["App.java"]:::infra

    subgraph "Presentation Layer"
        direction TB
        FXML1["About.fxml"]:::ui
        FXML2["JavaQuiz.fxml"]:::ui
        CSS1["about.css"]:::ui
        CSS2["home.css"]:::ui
        CSS3["content.css"]:::ui
        Images["images/"]:::ui
        NoteUI[/"JavaFX, JFoenix, FontAwesomeFX"/]:::ui
    end

    subgraph "Controllers"
        direction TB
        AC["AboutController"]:::controller
        JQC["JavaQuizController"]:::controller
    end

    subgraph "Data Access Layer"
        direction TB
        MC["MysqlConnection"]:::dao
        QD["QuestionDao"]:::dao
    end

    subgraph "Domain Model"
        direction TB
        QV["QuestionVo"]:::model
    end

    DatabaseScript["quiz_app_db.sql"]:::infra
    Database["MySQL DB"]:::db

    %% Connections
    Pom --> VBuild
    VBuild --> App
    App --> FXML1
    App --> FXML2
    FXML1 --> CSS1
    FXML2 --> CSS2
    FXML2 --> CSS3
    FXML1 --> Images
    FXML2 --> Images
    FXML1 --> AC
    FXML2 --> JQC
    AC --> QD
    JQC --> QD
    QD --> MC
    QD --> QV
    MC --> Database
    DatabaseScript --> Database

    %% Click Events
    click Pom "https://github.com/houarizegai/quiz-app/blob/master/pom.xml"
    click App "https://github.com/houarizegai/quiz-app/blob/master/src/main/java/com/houarizegai/quizappfx/App.java"
    click FXML1 "https://github.com/houarizegai/quiz-app/blob/master/src/main/resources/views/About.fxml"
    click FXML2 "https://github.com/houarizegai/quiz-app/blob/master/src/main/resources/views/JavaQuiz.fxml"
    click CSS1 "https://github.com/houarizegai/quiz-app/blob/master/src/main/resources/css/about.css"
    click CSS2 "https://github.com/houarizegai/quiz-app/blob/master/src/main/resources/css/home.css"
    click CSS3 "https://github.com/houarizegai/quiz-app/blob/master/src/main/resources/css/content.css"
    click AC "https://github.com/houarizegai/quiz-app/blob/master/src/main/java/com/houarizegai/quizappfx/controllers/AboutController.java"
    click JQC "https://github.com/houarizegai/quiz-app/blob/master/src/main/java/com/houarizegai/quizappfx/controllers/JavaQuizController.java"
    click MC "https://github.com/houarizegai/quiz-app/blob/master/src/main/java/com/houarizegai/quizappfx/dao/db/MysqlConnection.java"
    click QD "https://github.com/houarizegai/quiz-app/blob/master/src/main/java/com/houarizegai/quizappfx/dao/db/QuestionDao.java"
    click QV "https://github.com/houarizegai/quiz-app/blob/master/src/main/java/com/houarizegai/quizappfx/dao/vo/QuestionVo.java"
    click Images "https://github.com/houarizegai/quiz-app/tree/master/src/main/resources/images/"
    click DatabaseScript "https://github.com/houarizegai/quiz-app/blob/master/database/quiz_app_db.sql"

    %% Styles
    classDef ui fill:#9fc5e8,stroke:#036
    classDef controller fill:#b6d7a8,stroke:#082
    classDef dao fill:#f9cb9c,stroke:#a65
    classDef model fill:#c9c,stroke:#60
    classDef infra fill:#d9d2e9,stroke:#60
    classDef db fill:#ffe599,stroke:#e69138
```
