# teoloop/nomadax architecture

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

- Interactive diagram: https://gitdiagram.com/teoloop/nomadax
- Repository: https://github.com/teoloop/nomadax

## Overview

##### Project type and purpose
- NomadaX is a full-stack, containerized web application for booking short-term accommodations (Airbnb-style).
- The user-facing SPA (React + Vite) communicates over REST with a Java Spring Boot backend, which persists data in MySQL.

##### File structure
- Top-level:
- backend/ (Spring Boot app + Dockerfile + Maven)
- frontend/ (React + Vite + Dockerfile)
- docker-compose.yml (orchestrates frontend, backend, MySQL)
- init/nomadaxbkp.sql (DB schema/data)
- backend/src/main/java/com/nomadax: layered MVC style
- config/ (SecurityConfig, WebConfig)
- controller/ (HotelController)
- service/ (HotelService)
- repository/ (IHotelRepository, IImageRepository)
- entity/ (Hotel, Image, Reservation, User)
- exception/ (handlers, custom exceptions)
- frontend/src:
- pages/ (HomePage, HotelDetailPage, HotelsPage, AdminDashboard)
- components/ (Header, Footer, SearchBar, AddHotelModal, etc.)
- services/hotelService.js (REST client)

##### README for additional insights
- Stack: Java + Spring Boot, React + Vite, MySQL, Docker, Docker Compose, Maven
- Features: public hotel listings, detail view, recommendations, admin CRUD panel
- Deployment: spun up via docker-compose on ports 3000 (frontend), 8080 (backend), 3306 (MySQL)

##### Essential elements
- Clearly separate layers (UI → API → Persistence)
- Ports (3000, 8080, 3306)
- Docker Compose orchestrating all containers
- Init/nomadaxbkp.sql volume mount for DB schema loading

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Client
    Browser["Web Browser"]:::external

    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        FE["Frontend: React + Vite"]:::frontend
        subgraph "SPA Pages"
            direction TB
            Home["HomePage"]:::frontend
            Hotels["HotelsPage"]:::frontend
            Detail["HotelDetailPage"]:::frontend
            Admin["AdminDashboard"]:::frontend
        end
        subgraph "Components"
            direction TB
            Header["Header"]:::frontend
            Footer["Footer"]:::frontend
            Search["SearchBar"]:::frontend
            AddModal["AddHotelModal"]:::frontend
            EditModal["EditHotelModal"]:::frontend
            Rec["Recomendations"]:::frontend
            Cat["Categories"]:::frontend
        end
        ServiceJS["hotelService.js"]:::frontend
        Entry["main.jsx"]:::frontend
        HTML["index.html"]:::frontend
        Vite["vite.config.js"]:::frontend
        CSS["index.css"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend Layer"
        direction TB
        BE["Backend: Spring Boot"]:::backend
        Main["NomadaxBackendApplication.java"]:::backend
        subgraph "Config"
            direction TB
            Sec["SecurityConfig.java"]:::backend
            Web["WebConfig.java"]:::backend
        end
        subgraph "Controller"
            direction TB
            Controller["HotelController.java"]:::backend
        end
        subgraph "Service"
            direction TB
            BService["HotelService.java"]:::backend
        end
        subgraph "Repository"
            direction TB
            Repo1["IHotelRepository.java"]:::backend
            Repo2["IImageRepository.java"]:::backend
        end
        subgraph "Entity"
            direction TB
            E1["Hotel.java"]:::backend
            E2["Image.java"]:::backend
            E3["Reservation.java"]:::backend
            E4["User.java"]:::backend
        end
        subgraph "Exception"
            direction TB
            Ex1["GloblalExceptionHandler.java"]:::backend
            Ex2["ErrorResponse.java"]:::backend
            Ex3["DuplicateHotelNameException.java"]:::backend
        end
        Props["application.properties"]:::backend
        PropsD["application-docker.properties"]:::backend
    end

    %% Database
    DB[(MySQL Database)]:::database

    %% Orchestration
    subgraph "Docker Compose"
        direction TB
        DCompose["docker-compose.yml"]:::compose
        Init["nomadaxbkp.sql"]:::compose
    end

    %% Data Flows
    Browser -->|"HTTP 3000"| FE
    FE -->|"REST API 8080"| BE
    BE -->|"JDBC 3306"| DB
    DB --- Init
    DCompose --> FE
    DCompose --> BE
    DCompose --> DB

    %% Click Events
    click FE "https://github.com/teoloop/nomadax/tree/main/frontend/Dockerfile"
    click FE "https://github.com/teoloop/nomadax/tree/main/frontend/"
    click Home "https://github.com/teoloop/nomadax/blob/main/frontend/src/pages/HomePage.jsx"
    click Hotels "https://github.com/teoloop/nomadax/blob/main/frontend/src/pages/HotelsPage.jsx"
    click Detail "https://github.com/teoloop/nomadax/blob/main/frontend/src/pages/HotelDetailPage.jsx"
    click Admin "https://github.com/teoloop/nomadax/blob/main/frontend/src/pages/AdminDashboard.jsx"
    click Header "https://github.com/teoloop/nomadax/blob/main/frontend/src/components/Header.jsx"
    click Footer "https://github.com/teoloop/nomadax/blob/main/frontend/src/components/Footer.jsx"
    click Search "https://github.com/teoloop/nomadax/blob/main/frontend/src/components/SearchBar.jsx"
    click AddModal "https://github.com/teoloop/nomadax/blob/main/frontend/src/components/AddHotelModal.jsx"
    click EditModal "https://github.com/teoloop/nomadax/blob/main/frontend/src/components/EditHotelModal.jsx"
    click Rec "https://github.com/teoloop/nomadax/blob/main/frontend/src/components/Recomendations.jsx"
    click Cat "https://github.com/teoloop/nomadax/blob/main/frontend/src/components/Categories.jsx"
    click ServiceJS "https://github.com/teoloop/nomadax/blob/main/frontend/src/services/hotelService.js"
    click Entry "https://github.com/teoloop/nomadax/blob/main/frontend/src/main.jsx"
    click HTML "https://github.com/teoloop/nomadax/blob/main/frontend/index.html"
    click Vite "https://github.com/teoloop/nomadax/blob/main/frontend/vite.config.js"
    click CSS "https://github.com/teoloop/nomadax/blob/main/frontend/src/index.css"
    click BE "https://github.com/teoloop/nomadax/tree/main/backend/Dockerfile"
    click BE "https://github.com/teoloop/nomadax/tree/main/backend/"
    click Main "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/NomadaxBackendApplication.java"
    click Sec "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/config/SecurityConfig.java"
    click Web "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/config/WebConfig.java"
    click Controller "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/controller/HotelController.java"
    click BService "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/service/HotelService.java"
    click Repo1 "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/repository/IHotelRepository.java"
    click Repo2 "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/repository/IImageRepository.java"
    click E1 "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/entity/Hotel.java"
    click E2 "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/entity/Image.java"
    click E3 "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/entity/Reservation.java"
    click E4 "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/entity/User.java"
    click Ex1 "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/exception/GloblalExceptionHandler.java"
    click Ex2 "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/exception/ErrorResponse.java"
    click Ex3 "https://github.com/teoloop/nomadax/blob/main/backend/src/main/java/com/nomadax/exception/DuplicateHotelNameException.java"
    click Props "https://github.com/teoloop/nomadax/blob/main/backend/src/main/resources/application.properties"
    click PropsD "https://github.com/teoloop/nomadax/blob/main/backend/src/main/resources/application-docker.properties"
    click Init "https://github.com/teoloop/nomadax/blob/main/init/nomadaxbkp.sql"
    click DCompose "https://github.com/teoloop/nomadax/blob/main/docker-compose.yml"

    %% Styles
    classDef frontend fill:#D6EAF8,stroke:#3498DB,color:#000
    classDef backend fill:#D4EFDF,stroke:#2ECC71,color:#000
    classDef database fill:#F9E79F,stroke:#F39C12,color:#000
    classDef external fill:#F5F5F5,stroke:#7F8C8D,color:#000
    classDef compose fill:#E5E7E9,stroke:#85929E,color:#000
```
