# balchaki/meetspace architecture

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

- Interactive diagram: https://gitdiagram.com/balchaki/meetspace
- Repository: https://github.com/balchaki/meetspace

## Overview

##### Project type and purpose
- This is a full-stack room-reservation system comprised of:
- A Vue 3 single-page app (frontend)
- A Spring Boot (Java 17) REST API (backend)
- A PostgreSQL database (with Flyway migrations)
- Purpose: allow users to view available meeting rooms, make/cancel bookings, and allow administrators to manage rooms, users, and reservations.

##### File structure
- Top-level “frontend” folder: Vue 3 code, components, views, router, store, API service, Tailwind/CSS, Vite build.
- Top-level “src/main/java/br/balchaki/meetspace”: Spring Boot app entrypoint, controllers (HTTP endpoints), domain entities & repositories, DTOs, services, security, global config, exception handling.
- src/main/resources/db/migration: Flyway SQL scripts (V1…V5) initialize/update tables.
- application.properties: DB credentials and server configuration.
- Security: JwtAuthenticationFilter, JwtRequestFilter, JwtUtil, SecurityConfig.
- Tests: basic Spring Boot integration test.

##### Key architecture insights from README
- Frontend served separately by Vite (http://localhost:5173).
- Backend runs on Spring Boot embedded server.
- DB auto-migrations on startup.
- Main features: room availability check, room/user/reservation management via admin panel.

##### Main components & interactions
a. Components:
1. Client Browser (Vue SPA)
2. Frontend App (components, router, Vuex/store)
3. REST API Gateway (Spring Boot controllers)
4. Service Layer (business logic: ReserveService, RoomService, UserService, AdminService, JwtService)
5. Data Access Layer (JPA Repositories for User, Room, Reserve)
6. PostgreSQL Database (with schema managed by Flyway)
7. Security Modules (JWT filters, authentication endpoint)
b. Interactions:
- User → Browser UI → API calls (axios/fetch via /api/*)
- API Gateway → delegates to Services → uses Repositories → queries/updates DB
- JWT filters intercept secured endpoints, validate tokens (login/refresh flows)
- Admin UI calls protected endpoints for CRUD operations
c. Architectural patterns:
- Layered (Controller → Service → Repository → DB)
- MVC (in backend controllers/views of REST)
- JWT-based stateless authentication
- Flyway for DB migrations
- SPA + REST separation
d. Technologies & frameworks:
- Frontend: Vue 3, Vue Router, Pinia/Vuex (store), Vite, Tailwind CSS, Axios
- Backend: Spring Boot, Spring Security, Spring Data JPA, Flyway, Maven
- DB: PostgreSQL

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User interacts with frontend
    User["User"]:::user
    User -->|Uses UI| VueSPA

    %% Frontend Layer
    subgraph "Frontend" 
        direction TB
        VueSPA["Vue SPA"]:::frontend
        Router["Router\n(frontend/src/router/index.js)"]:::frontend
        StoreDir["Store\n(frontend/src/store"]:::frontend
        APIService["API Service\n(api.js)"]:::frontend
        Utils["Auth Utils\n(auth.js)"]:::frontend
        ComponentsDir["Components\n(components/)"]:::frontend
        ViewsDir["Views\n(views/)"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend" 
        direction TB
        Application["MeetSpaceApplication.java"]:::backend
        Security["JWT Security\n(filters & util)"]:::security
        Controllers["Controllers\n(controllers/)"]:::backend
        Services["Services\n(service/)"]:::backend
        Repositories["Repositories\n(domain/)"]:::backend
        DTOs["DTOs\n(dto/)"]:::backend
        Config["Config & Exceptions\n(config/)"]:::backend
    end

    %% Database Layer
    subgraph "Database"
        direction TB
        Flyway["Flyway Migrations\n(db/migration/)"]:::db
        DB["PostgreSQL DB"]:::db
    end

    %% Interactions
    VueSPA -->|HTTP REST| Security
    Security -->|Validates & Forwards| Controllers
    Controllers -->|Calls| Services
    Services -->|Uses JPA| Repositories
    Repositories -->|Queries| DB
    Flyway -->|Runs V1–V5| DB

    %% Click Events
    click VueSPA "https://github.com/balchaki/meetspace/tree/main/frontend/src"
    click Router "https://github.com/balchaki/meetspace/blob/main/frontend/src/router/index.js"
    click StoreDir "https://github.com/balchaki/meetspace/tree/main/frontend/src/store"
    click APIService "https://github.com/balchaki/meetspace/blob/main/frontend/src/services/api.js"
    click Utils "https://github.com/balchaki/meetspace/blob/main/frontend/src/utils/auth.js"
    click ComponentsDir "https://github.com/balchaki/meetspace/tree/main/frontend/src/components"
    click ViewsDir "https://github.com/balchaki/meetspace/tree/main/frontend/src/views"
    click Application "https://github.com/balchaki/meetspace/blob/main/src/main/java/br/balchaki/meetspace/MeetSpaceApplication.java"
    click Security "https://github.com/balchaki/meetspace/tree/main/src/main/java/br/balchaki/meetspace/security"
    click Controllers "https://github.com/balchaki/meetspace/tree/main/src/main/java/br/balchaki/meetspace/controllers"
    click Services "https://github.com/balchaki/meetspace/tree/main/src/main/java/br/balchaki/meetspace/service"
    click Repositories "https://github.com/balchaki/meetspace/tree/main/src/main/java/br/balchaki/meetspace/domain"
    click DTOs "https://github.com/balchaki/meetspace/tree/main/src/main/java/br/balchaki/meetspace/dto"
    click Config "https://github.com/balchaki/meetspace/tree/main/src/main/java/br/balchaki/meetspace/config"
    click Flyway "https://github.com/balchaki/meetspace/tree/main/src/main/resources/db/migration"
    click DB "https://github.com/balchaki/meetspace/blob/main/src/main/resources/application.properties"
    click Tests "https://github.com/balchaki/meetspace/blob/main/src/test/java/br/balchaki/meetspace/MeetSpaceApplicationTests.java"

    %% Styles
    classDef frontend fill:#E3F2FD,stroke:#90CAF9,color:#0D47A1;
    classDef backend fill:#E8F5E9,stroke:#A5D6A7,color:#1B5E20;
    classDef db fill:#FFF3E0,stroke:#FFCC80,color:#E65100;
    classDef security fill:#FFEBEE,stroke:#EF9A9A,color:#B71C1C;
    classDef user fill:#ECEFF1,stroke:#B0BEC5,color:#37474F;
```
