# nettee-space/backend-sample-hexagonal-simple-crud architecture

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

- Interactive diagram: https://gitdiagram.com/nettee-space/backend-sample-hexagonal-simple-crud
- Repository: https://github.com/nettee-space/backend-sample-hexagonal-simple-crud

## Overview

##### Main Components

a) Core Components:
- Application Core (Hexagon Center)
- Domain Layer
- Use Cases
- Ports (Interfaces)

b) External Components:
- Driving Adapters (Primary/Input)
- Web Controllers
- Driven Adapters (Secondary/Output)
- Database (JPA)

##### Center (Inner Hexagon)
- Use cases (BoardCreateUseCase, BoardReadUseCase, etc.)
- Ports (BoardCommandPort, BoardQueryPort)

##### First Ring (Ports)
- Separate into:
- Input/Driving Ports (left side)
- Output/Driven Ports (right side)

##### Outer Ring (Adapters)
- Adapters connecting to the ports
- Left side: Web/API adapters
- Right side: Database adapters

##### Specific Elements

a) Domain Core:
- Board (Domain Entity)
- BoardStatus (Enumeration)

b) Use Cases:
- BoardCreateUseCase
- BoardReadUseCase
- BoardUpdateUseCase
- BoardDeleteUseCase

c) Ports:
- BoardCommandPort
- BoardQueryPort

##### Flow Representation

- Data flow direction with arrowheads
- Request/response paths

##### Technical Stack Indicators

Technology choices:
- Spring Boot
- JPA
- Flyway
- Kotlin (for tests)
- Gradle

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and Classes
    classDef domain fill:#e1f5fe,stroke:#01579b
    classDef usecase fill:#e8f5e9,stroke:#2e7d32
    classDef port fill:#fff3e0,stroke:#ff6f00
    classDef adapter fill:#f3e5f5,stroke:#6a1b9a
    classDef database fill:#ede7f6,stroke:#4527a0
    classDef config fill:#fce4ec,stroke:#880e4f

    %% Main Application
    APP["HexagonalApplication"]:::config
    click APP "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/java/me/nettee/HexagonalApplication.java"

    %% Configuration
    subgraph Configuration
        CONFIG["Application Config"]:::config
        LOCALCONFIG["Local Config"]:::config
        PROPS["Properties"]:::config
    end
    click CONFIG "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/resources/application.yml"
    click LOCALCONFIG "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/resources/application-local.yml"
    click PROPS "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/resources/application.properties"

    %% Domain Layer
    subgraph Domain
        BOARD["Board Entity"]:::domain
        BSTATUS["BoardStatus"]:::domain
    end
    click BOARD "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/java/me/nettee/board/application/domain/Board.java"
    click BSTATUS "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/java/me/nettee/board/application/domain/type/BoardStatus.java"

    %% Use Cases
    subgraph UseCases
        CREATE["BoardCreateUseCase"]:::usecase
        READ["BoardReadUseCase"]:::usecase
        UPDATE["BoardUpdateUseCase"]:::usecase
        DELETE["BoardDeleteUseCase"]:::usecase
    end
    click CREATE "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/java/me/nettee/board/application/usecase/BoardCreateUseCase.java"
    click READ "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/java/me/nettee/board/application/usecase/BoardReadUseCase.java"
    click UPDATE "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/java/me/nettee/board/application/usecase/BoardUpdateUseCase.java"
    click DELETE "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/java/me/nettee/board/application/usecase/BoardDeleteUseCase.java"

    %% Ports
    subgraph Ports
        CMDPORT["BoardCommandPort"]:::port
        QRYPORT["BoardQueryPort"]:::port
    end
    click CMDPORT "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/java/me/nettee/board/application/port/BoardCommandPort.java"
    click QRYPORT "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/java/me/nettee/board/application/port/BoardQueryPort.java"

    %% Database
    subgraph Database
        DB[("Database")]:::database
        SCHEMA["Init Schema"]:::database
        BOARD_TABLE["Board Table"]:::database
    end
    click SCHEMA "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/resources/db/migration/v1_0/V1_0_0__init_schema.sql"
    click BOARD_TABLE "https://github.com/nettee-space/backend-sample-hexagonal-simple-crud/blob/main/src/main/resources/db/migration/v1_0/V1_0_1__create_tb_board.sql"

    %% Relationships
    APP --> CONFIG
    APP --> LOCALCONFIG
    APP --> PROPS

    CREATE --> BOARD
    READ --> BOARD
    UPDATE --> BOARD
    DELETE --> BOARD
    
    BOARD --> BSTATUS

    CREATE --> CMDPORT
    UPDATE --> CMDPORT
    DELETE --> CMDPORT
    READ --> QRYPORT

    CMDPORT -.-> DB
    QRYPORT -.-> DB
    
    DB --> SCHEMA
    DB --> BOARD_TABLE

    %% Legend
    subgraph Legend
        L1["Domain Objects"]:::domain
        L2["Use Cases"]:::usecase
        L3["Ports"]:::port
        L4["Database"]:::database
        L5["Configuration"]:::config
    end
```
