# savemos/fleetfra architecture

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

- Interactive diagram: https://gitdiagram.com/savemos/fleetfra
- Repository: https://github.com/savemos/fleetfra

## Overview

##### Project type and purpose
- From the file tree and README, this is a full-stack, turn-based “Battleship”-style game called FleetFra.
- Frontend: static HTML/JS/CSS under src/main/resources/static
- Backend 1: Java Spring-style REST API + WebSocket entry point under src/main/java
- Backend 2: Erlang/OTP‐based game engine under src/main/fleetfra_chin
- Reverse proxy / load balancer: NGINX (src/main/NGINX)
- Database: relational store via JDBC (FleetFra.sql, DAO layer)

##### File structure
- Top-level:
- pom.xml, mvnw → Maven build for Java
- src/main/NGINX → NGINX configuration and install docs
- src/main/fleetfra_chin → Erlang OTP application with rebar.config
- src/main/java/it/unipi/dsmt/FleetFra → Java controllers, services, DAOs, DTOs
- src/main/resources/static → HTML/JS/CSS UI
- src/main/resources/application.properties → DB connection, app properties
- Testing: JUnit tests for Java and a Java‐level websocket test
- Documentation: PDF in Documentation/

##### Key README insights
- User flows: login (player/admin), ship placement, game turn, end condition

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client/UI Layer
    subgraph "Client/UI Layer"
        Browser["Web Browser"]:::ui
        StaticAssets["Static Assets (HTML/JS/CSS)"]:::ui
    end

    %% NGINX Reverse Proxy
    subgraph "NGINX Reverse Proxy"
        Proxy["NGINX (nginx.conf)"]:::proxy
        ProxyDocs["NGINX Docs"]:::proxy
    end

    %% Java Application
    subgraph "Java Application (FleetFra)" 
        AppEntry["FleetFraApplication"]:::java
        subgraph Controllers
            AdminController["AdminController"]:::java
            UserController["UserController"]:::java
            GenericController["GenericController"]:::java
        end
        subgraph Services
            UserService["UserService"]:::java
            Matchmaking["Matchmaking"]:::java
        end
        subgraph DAOs
            BaseDAO["BaseDAO"]:::java
            UserDAO["UserDAO"]:::java
            MatchDAO["MatchDAO"]:::java
        end
        subgraph DTOs
            UserDTO["UserDTO"]:::java
            MatchDTO["MatchDTO"]:::java
            DateDTO["DateDTO"]:::java
            ResponseRequest["ResponseRequest"]:::java
            UserAccessRequest["UserAccessRequest"]:::java
            ViewUsersRequestDTO["ViewUsersRequestDTO"]:::java
        end
        CORSFilter["CORSFilter"]:::java
        ApplicationProperties["application.properties"]:::java
        BeansXML["beans.xml"]:::java
    end

    %% Erlang OTP Game Engine
    subgraph "Erlang OTP Game Engine"
        ErlangCore["fleetfra_chin app"]:::erlang
    end

    %% Database
    DB["Relational Database (FleetFra.sql)"]:::db

    %% Connections
    Browser -->|"HTTP GET static"| Proxy
    Browser -->|"HTTP/HTTPS API"| Proxy
    Browser -->|"WebSocket /ws/game"| Proxy

    Proxy -->|"serves static files"| StaticAssets
    Proxy -->|"forwards API calls"| AppEntry
    Proxy -->|"upgrades WS to Erlang"| ErlangCore

    AppEntry -->|"calls Controllers"| AdminController
    AppEntry -->|"calls Controllers"| UserController
    AppEntry -->|"calls Controllers"| GenericController

    AdminController -->|"uses"| UserService
    UserController -->|"uses"| UserService
    GenericController -->|"uses"| Matchmaking

    UserService -->|"uses"| BaseDAO
    Matchmaking -->|"uses"| MatchDAO

    UserController -->|"uses"| UserDAO
    GenericController -->|"uses"| BaseDAO

    BaseDAO -->|"wire JDBC"| DB
    UserDAO -->|"wire JDBC"| DB
    MatchDAO -->|"wire JDBC"| DB

    AppEntry -->|"applies filter"| CORSFilter
    AppEntry -->|"loads"| ApplicationProperties
    AppEntry -->|"loads"| BeansXML

    ErlangCore -->|"manages in-memory state"| ErlangCore
    ErlangCore -->|"optional local TCP/REST"| AppEntry

    %% Data flows
    AppEntry -->|"JDBC"| DB
    ErlangCore -->|"persistent Game data"| DB

    %% Click Events
    click StaticAssets "https://github.com/savemos/fleetfra/tree/master/src/main/resources/static/"
    click Proxy "https://github.com/savemos/fleetfra/blob/master/src/main/NGINX/nginx.conf"
    click ProxyDocs "https://github.com/savemos/fleetfra/tree/master/src/main/NGINX/"
    click AppEntry "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/FleetFraApplication.java"
    click AdminController "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/controller/impl/AdminController.java"
    click UserController "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/controller/impl/UserController.java"
    click GenericController "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/controller/impl/GenericController.java"
    click UserService "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/service/UserService.java"
    click Matchmaking "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/service/Matchmaking.java"
    click BaseDAO "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/DAO/BaseDAO.java"
    click UserDAO "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/DAO/UserDAO.java"
    click MatchDAO "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/DAO/MatchDAO.java"
    click UserDTO "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/DTO/UserDTO.java"
    click MatchDTO "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/DTO/MatchDTO.java"
    click DateDTO "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/DTO/DateDTO.java"
    click ResponseRequest "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/DTO/ResponseRequest.java"
    click UserAccessRequest "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/DTO/UserAccessRequest.java"
    click ViewUsersRequestDTO "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/DTO/ViewUsersRequestDTO.java"
    click CORSFilter "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/CORSFilter.java"
    click ApplicationProperties "https://github.com/savemos/fleetfra/blob/master/src/main/resources/application.properties"
    click BeansXML "https://github.com/savemos/fleetfra/blob/master/src/main/resources/META-INF/beans.xml"
    click ErlangCore "https://github.com/savemos/fleetfra/tree/master/src/main/fleetfra_chin/"
    click DB "https://github.com/savemos/fleetfra/blob/master/src/main/java/it/unipi/dsmt/FleetFra/FleetFra.sql"

    %% Styles
    classDef ui fill:#cce5ff,stroke:#036,stroke-width:1px
    classDef proxy fill:#999999,stroke:#333333,stroke-width:1px
    classDef java fill:#d5f5e3,stroke:#007f00,stroke-width:1px
    classDef erlang fill:#ffddcc,stroke:#d35400,stroke-width:1px
    classDef db fill:#eeeeee,stroke:#666666,stroke-width:1px
```
