# frozsgy/ceng453-project architecture

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

- Interactive diagram: https://gitdiagram.com/frozsgy/ceng453-project
- Repository: https://github.com/frozsgy/ceng453-project

## Overview

##### Project type and purpose
- This is a full-stack multiplayer card game application with two Maven sub-modules:
- client – a JavaFX desktop client implementing MVC (FXML views + Controllers), game logic (Strategy pattern for AI), state management, HTTP and socket services.
- server – a Spring Boot REST + socket server providing authentication (JWT + Spring Security), game and player APIs, real-time multiplayer via sockets, persistence (JPA repositories), and email utilities for password reset.

##### File structure
- Top‐level: client/, server/, wiki/
- client/:
- src/main/java/group10/client: Application entry (UiApplication), StageInitializer, package breakdown: constants, controller (UI event handling), model & entity (data transfer objects & domain entities), logic (AiStrategy + GameLogic), service (HTTPService, SocketClient/Server), state (session + scoreboard storage), utility.
- resources: FXML views, application.yml, static assets.
- server/:
- src/main/java/group10/server: ServerApplication entry; config (JWTAuthorizationFilter, WebSecurityConfig, DataLoader), controller (GameController, PlayerController), service (GameService, MatchService, PlayerService), repository (JPA repos), entity, DTO models, util (EmailComposer).
- resources: application.yml, Postman collection, Swagger doc.

##### README/wiki for insights
- Wiki pages describe AI strategies, database design, security, design patterns, tests.
- Server README describes API endpoints and configuration.

##### Main components & interactions
a. Components
- Client Application (UI Layer, Controllers, Logic & AI, State Management, HTTPService, SocketClient)
- Server Application (Spring Boot, JWT Auth Filter, REST Controllers, Socket Server, Service Layer, Repository Layer)
- Database (e.g., MySQL/PostgreSQL via JPA)
- External Email/SMS Service (for password reset codes)
- Optional Static CDN (for client assets, if deployed)
b. Relationships/Data flow
1. UI (FXML + Controllers) ↔ Logic & State ↔ HTTPService → REST API endpoints → Controllers → Services → Repositories → Database
2. HTTPService ↔ Authentication endpoints (login, register, password reset) using JWT
3. SocketClient ↔ SocketServer → real-time game events routed via GameService & MatchService
4. Services → EmailComposer → External SMTP for sending reset codes
c. Architectural patterns & design principles
- Client: MVC (Views, Controllers, Model), Strategy pattern for AI levels, Singleton or in-memory Storage for session/scoreboard, Dependency Injection via FXML & PropertiesLoader
- Server: Layered architecture (Controller → Service → Repository), DTO pattern, JWT-based stateless auth, Filter chain for security, SpringFox/Swagger for API docs, DataLoader for seeding
d. Key technologies/frameworks
- Client: Java 11+, JavaFX, Maven Wrapper, FXML, HTTP & Socket I/O, Jackson/Gson (if used), YAML config
- Server: Spring Boot, Spring Web, Spring Security, JWT, Spring Data JPA, Hibernate, Swagger (SpringFox), Maven, Postman collection

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Application
    subgraph "Client Application"
        direction TB
        UiApp["UiApplication"]:::client
        StageInit["StageInitializer"]:::client
        Controllers["MVC Controllers"]:::client
        Views["FXML Views"]:::client
        Logic["Game Logic & AI"]:::client
        State["State Management"]:::client
        HTTP["HTTPService"]:::client
        SocketC["SocketClient"]:::client
        SocketS["SocketServer"]:::client
        ClientConf["application.yml"]:::client
    end

    %% Server Application
    subgraph "Server Application"
        direction TB
        ServerApp["ServerApplication"]:::server
        JWTFilter["JWTAuthorizationFilter"]:::server
        WebSec["WebSecurityConfig"]:::server
        DataLoad["DataLoader"]:::server
        ControllersSrv["REST Controllers"]:::server
        Services["Service Layer"]:::server
        Repos["Repository Layer"]:::server
        Entities["Persistence Entities"]:::server
        DTOs["DTO Models"]:::server
        EmailUtil["EmailComposer"]:::server
        ServerConf["application.yml"]:::server
        Postman["Postman Collection"]:::server
        SocketSrv["Socket Server"]:::server
    end

    %% External Systems
    DB[(Database)]:::external
    Email[(External SMTP Service)]:::external

    %% Connections: Client -> Server via HTTP
    Views -->|user events| Controllers
    Controllers -->|update state| State
    State -->|invoke AI| Logic
    Logic -->|HTTP/REST| HTTP
    HTTP -->|HTTP/REST| ControllersSrv
    %% Authentication via HTTP
    HTTP -->|HTTP/REST| JWTFilter
    JWTFilter --> ControllersSrv
    ControllersSrv --> Services
    Services --> Repos
    Repos --> DB
    %% Socket real-time
    Logic -->|WebSocket/TCP| SocketC
    SocketC -->|WebSocket/TCP| SocketSrv
    SocketSrv --> Services
    %% Email for password reset
    ControllersSrv -->|trigger reset| EmailUtil
    EmailUtil -->|SMTP| Email

    %% Click Events - Client
    click UiApp "https://github.com/frozsgy/ceng453-project/blob/master/client/src/main/java/group10/client/UiApplication.java"
    click StageInit "https://github.com/frozsgy/ceng453-project/blob/master/client/src/main/java/group10/client/StageInitializer.java"
    click Controllers "https://github.com/frozsgy/ceng453-project/tree/master/client/src/main/java/group10/client/controller"
    click Views "https://github.com/frozsgy/ceng453-project/tree/master/client/src/main/resources/fxml"
    click Logic "https://github.com/frozsgy/ceng453-project/tree/master/client/src/main/java/group10/client/logic"
    click State "https://github.com/frozsgy/ceng453-project/tree/master/client/src/main/java/group10/client/state"
    click HTTP "https://github.com/frozsgy/ceng453-project/blob/master/client/src/main/java/group10/client/service/HTTPService.java"
    click SocketC "https://github.com/frozsgy/ceng453-project/blob/master/client/src/main/java/group10/client/service/SocketClient.java"
    click SocketS "https://github.com/frozsgy/ceng453-project/blob/master/client/src/main/java/group10/client/service/SocketServer.java"
    click ClientConf "https://github.com/frozsgy/ceng453-project/blob/master/client/src/main/resources/application.yml"

    %% Click Events - Server
    click ServerApp "https://github.com/frozsgy/ceng453-project/blob/master/server/src/main/java/group10/server/ServerApplication.java"
    click JWTFilter "https://github.com/frozsgy/ceng453-project/blob/master/server/src/main/java/group10/server/config/JWTAuthorizationFilter.java"
    click WebSec "https://github.com/frozsgy/ceng453-project/blob/master/server/src/main/java/group10/server/config/WebSecurityConfig.java"
    click DataLoad "https://github.com/frozsgy/ceng453-project/blob/master/server/src/main/java/group10/server/config/DataLoader.java"
    click ControllersSrv "https://github.com/frozsgy/ceng453-project/blob/master/server/src/main/java/group10/server/controller/GameController.java"
    click ControllersSrv "https://github.com/frozsgy/ceng453-project/blob/master/server/src/main/java/group10/server/controller/PlayerController.java"
    click Services "https://github.com/frozsgy/ceng453-project/tree/master/server/src/main/java/group10/server/service"
    click Repos "https://github.com/frozsgy/ceng453-project/tree/master/server/src/main/java/group10/server/repository"
    click Entities "https://github.com/frozsgy/ceng453-project/tree/master/server/src/main/java/group10/server/entity"
    click DTOs "https://github.com/frozsgy/ceng453-project/tree/master/server/src/main/java/group10/server/model"
    click EmailUtil "https://github.com/frozsgy/ceng453-project/blob/master/server/src/main/java/group10/server/util/EmailComposer.java"
    click ServerConf "https://github.com/frozsgy/ceng453-project/blob/master/server/src/main/resources/application.yml"
    click Postman "https://github.com/frozsgy/ceng453-project/blob/master/server/docs/CENG453_Server_API_Endpoints.postman_collection.json"

    %% Styles
    classDef client fill:#D0E8FF,stroke:#005BBB,color:#000
    classDef server fill:#DFF2D8,stroke:#2F6627,color:#000
    classDef external fill:#FFE8D0,stroke:#BB5B00,color:#000
```
