# pedro0402/planner architecture

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

- Interactive diagram: https://gitdiagram.com/pedro0402/planner
- Repository: https://github.com/pedro0402/planner

## Overview

##### Project Type and Purpose
- This is a backend-only RESTful service (“Planejador de Viagens”) written in Java 17+ with Spring Boot.
- It exposes HTTP endpoints to manage users (participants), trips, activities and links, persisting data in MySQL.
- Flyway handles database migrations on startup.

##### File Structure
- Top‐level “planner” module with Maven wrapper, pom.xml, src and src/main/resources.
- Under `src/main/java/com/rocketseat/planner`:
- Four feature‐based packages: `participant`, `trip`, `activity`, `link`. Each contains:
– Entity class (`*.java`)
– Data (DTO) classes (`*Data.java`)
– Request/Response payload classes
– Repository interfaces (Spring Data JPA)
– Service classes
– Controllers (only in participant and trip packages)
- Database migrations in `src/main/resources/db/migration` (V1..V4 SQL scripts).
- `application.properties` configures the datasource and JPA.
- Tests under `src/test/java`.

##### Key Insights from README
- Uses Spring Boot, Spring Data JPA, MySQL, Maven.
- Exposes endpoints for users (`/usuarios`) and trips (`/viagens`).
- Planned future layers: authentication (JWT), favorites, recommendations, cloud deploy.

##### Main Architectural Components
a. API Layer
- Spring MVC Controllers (`ParticipantController`, `TripController`)
b. Service Layer
- Business logic in `*Service` classes for each domain (participant, trip, activity, link)
c. Persistence Layer
- Spring Data JPA Repositories
- Entities managed via Hibernate
- Flyway migration scripts
d. Database
- MySQL instance with tables: trips, participants, activities, links
e. External Tools
- Flyway (migration)
- Postman (for testing)
- Maven (build management)

##### Relationships and Data Flow
- Client → HTTP request → Controller
- Controller calls Service (business rules)
- Service delegates to Repository (CRUD ops)
- Repository ↔ MySQL database
- Flyway executes SQL scripts on application startup before repositories run
- Test suite hits Controllers or Services for integration/unit tests

##### Architectural Patterns & Principles
- Layered architecture (Controller → Service → Repository)
- Domain‐driven package structure (feature‐based grouping)
- RESTful API design
- Separation of concerns (DTOs vs Entities)
- Database migrations with Flyway

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Build & Configuration
    subgraph "Build & Config"
        Maven["Maven Wrapper & pom.xml"]:::config
        Application["PlannerApplication"]:::entrypoint
    end

    %% Client
    Client["Client (Postman/Browser)"]:::external

    %% API Layer
    subgraph "API Layer"
        ParticipantController["ParticipantController"]:::api
        TripController["TripController"]:::api
    end

    %% Service Layer
    subgraph "Service Layer"
        ParticipantService["ParticipantService"]:::service
        TripService["TripService"]:::service
        ActivityService["ActivityService"]:::service
        LinkService["LinkService"]:::service
    end

    %% Persistence Layer
    subgraph "Persistence Layer"
        ParticipantRepository["ParticipantRepository"]:::repo
        TripRepository["TripRepository"]:::repo
        ActivityRepository["ActivityRepository"]:::repo
        LinkRepository["LinkRepository"]:::repo
    end

    %% Database and Migrations
    subgraph "Database"
        MySQL[(MySQL Database)]:::db
        Flyway["Flyway Migrations"]:::migration
    end

    %% Tests
    Tests["PlannerApplicationTests"]:::test

    %% Configuration
    Config["application.properties"]:::config

    %% Data Flow
    Client -->|"HTTP Request"| ParticipantController
    Client -->|"HTTP Request"| TripController

    ParticipantController -->|"invoke"| ParticipantService
    TripController -->|"invoke"| TripService

    ParticipantService -->|"CRUD ops"| ParticipantRepository
    TripService -->|"CRUD ops"| TripRepository
    ActivityService -->|"CRUD ops"| ActivityRepository
    LinkService -->|"CRUD ops"| LinkRepository

    ParticipantRepository -->|"SQL queries"| MySQL
    TripRepository -->|"SQL queries"| MySQL
    ActivityRepository -->|"SQL queries"| MySQL
    LinkRepository -->|"SQL queries"| MySQL

    Flyway -->|"migrations on startup"| MySQL

    Tests -->|"integration/unit tests"| ParticipantController
    Tests -->|"integration/unit tests"| ParticipantService

    Application -->|"startup"| Flyway
    Application -->|"startup"| Config

    %% Click Events
    click Application "https://github.com/pedro0402/planner/blob/main/planner/src/main/java/com/rocketseat/planner/PlannerApplication.java"
    click ParticipantController "https://github.com/pedro0402/planner/blob/main/planner/src/main/java/com/rocketseat/planner/participant/ParticipantController.java"
    click TripController "https://github.com/pedro0402/planner/blob/main/planner/src/main/java/com/rocketseat/planner/trip/TripConroller.java"
    click ParticipantService "https://github.com/pedro0402/planner/blob/main/planner/src/main/java/com/rocketseat/planner/participant/ParticipantService.java"
    click ActivityService "https://github.com/pedro0402/planner/blob/main/planner/src/main/java/com/rocketseat/planner/activity/ActivityService.java"
    click LinkService "https://github.com/pedro0402/planner/blob/main/planner/src/main/java/com/rocketseat/planner/link/LinkService.java"
    click ParticipantRepository "https://github.com/pedro0402/planner/blob/main/planner/src/main/java/com/rocketseat/planner/participant/ParticipantRepository.java"
    click TripRepository "https://github.com/pedro0402/planner/blob/main/planner/src/main/java/com/rocketseat/planner/trip/TripRepository.java"
    click ActivityRepository "https://github.com/pedro0402/planner/blob/main/planner/src/main/java/com/rocketseat/planner/activity/ActivityRepository.java"
    click LinkRepository "https://github.com/pedro0402/planner/blob/main/planner/src/main/java/com/rocketseat/planner/link/LinkRepository.java"
    click Config "https://github.com/pedro0402/planner/blob/main/planner/src/main/resources/application.properties"
    click Maven "https://github.com/pedro0402/planner/blob/main/planner/pom.xml"
    click Tests "https://github.com/pedro0402/planner/blob/main/planner/src/test/java/com/rocketseat/planner/PlannerApplicationTests.java"
    click Flyway "https://github.com/pedro0402/planner/tree/main/planner/src/main/resources/db/migration"

    %% Styles
    classDef external fill:#d3d3d3,stroke:#555,stroke-width:1px;
    classDef api fill:#ADD8E6,stroke:#333,stroke-width:1px;
    classDef service fill:#90EE90,stroke:#333,stroke-width:1px;
    classDef repo fill:#FFA500,stroke:#333,stroke-width:1px;
    classDef db fill:#B0E0E6,stroke:#333,stroke-width:1px,shape:cylinder;
    classDef migration fill:#FFD700,stroke:#333,stroke-width:1px;
    classDef config fill:#DCDCDC,stroke:#333,stroke-width:1px;
    classDef entrypoint fill:#DDA0DD,stroke:#333,stroke-width:1px;
    classDef test fill:#FFC0CB,stroke:#333,stroke-width:1px;
```
