# igor-baiborodine/campsite-booking-go architecture

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

- Interactive diagram: https://gitdiagram.com/igor-baiborodine/campsite-booking-go
- Repository: https://github.com/igor-baiborodine/campsite-booking-go

## Overview

##### Project Type and Purpose
- This is a standalone Go‐based backend microservice that exposes a gRPC API for managing campsites and bookings.
- Clients call RPC methods (CreateCampsite, CreateBooking, UpdateBooking, CancelBooking, GetBooking, GetCampsites, GetVacantDates).
- Data is persisted in a PostgreSQL database.
- The project follows a layered (hexagonal/clean) architecture with clear separation of concerns (application, domain, infrastructure).

##### Key Directories and Their Roles
- cmd/main.go: application entry point—builds config, logger, DB connection, gRPC server and registers services.
- internal/config: holds configuration loading logic (env/flags).
- internal/logger: centralized logging setup.
- internal/grpc: gRPC server setup and interceptors (logging, validation).
- internal/application: core use‐case layer implementing commands (create/update/cancel) and queries (get bookings, get campsites, get vacant dates), plus validation and decorators.
- internal/domain: domain entities (Booking, Campsite), domain interfaces (repositories, validators) and business rules.
- internal/postgres: PostgreSQL adapters implementing domain repository interfaces; SQL queries and helpers.
- internal/service: composition roots—wiring repositories, validators, and application services.
- internal/waiter: utility to wait for dependencies (e.g. DB readiness).
- db: SQL migration scripts and DB initialization.
- datagenerator: stand‐alone tool to generate sample data.
- docker & k8s: containerization and orchestration manifests.
- tests: end‐to‐end/performance and concurrency tests.

##### Architectural Patterns
- Hexagonal/Clean Architecture:
- Inner circle – domain entities & interfaces.
- Application services – orchestrate commands and queries against domain.
- Adapters – gRPC transport and Postgres persistence.
- Dependency Injection: components wired in cmd/main or internal/service.
- gRPC Interceptors: for logging, error handling, validation.
- Migrations + test containers for integration testing.

##### Components
- External Clients (e.g. CLI, other microservices)
- gRPC API Layer
- Server & Interceptors
- Protobuf-generated stubs
- Application Layer
- Command Handlers
- Query Handlers
- Validators & Decorators
- Domain Layer
- Entities (Campsite, Booking)
- Interfaces (BookingRepository, CampsiteRepository, BookingValidator)
- Infrastructure Layer
- Postgres Adapter (SQL queries, connection)
- Configuration & Logger
- PostgreSQL Database
- Auxiliary Tools (DataGenerator)
- CI/CD & Deployment
- Docker images
- Kubernetes manifests
- Migrations

##### Relationships and Data Flows
- Client → gRPC API Layer: RPC call
- gRPC → Application Layer: calls command/query handler
- Application → Domain: applies business rules
- Domain → Infrastructure: calls repository interfaces
- Infrastructure → Postgres: executes SQL
- Responses flow back in reverse order
- Cross‐cutting: Config & Logger injected at startup; Interceptors apply to every RPC.

## Diagram (Mermaid)

```mermaid
graph TD

    %% External Clients
    Clients["External Clients"]:::external

    %% Startup
    Startup["Startup (cmd/main.go)"]:::infra
    click Startup "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/cmd/main.go"

    %% Transport Layer
    subgraph "Transport Layer"
        GRPC["gRPC Server"]:::transport
        Interceptors["Interceptors"]:::transport
        ProtoStubs["Protobuf Stubs"]:::transport
    end
    click GRPC "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/grpc/server.go"
    click Interceptors "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/grpc/interceptors.go"
    click ProtoStubs "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/campgroundspb/v1/api.pb.go"
    click ProtoStubs "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/campgroundspb/v1/api_grpc.pb.go"

    %% Config & Logger
    Config["Config Loader"]:::infra
    Logger["Logger"]:::infra
    click Config "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/config/config.go"
    click Logger "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/logger/logger.go"

    %% Application Layer
    subgraph "Application Layer"
        CC["CreateCampsite Handler"]:::app
        CB["CreateBooking Handler"]:::app
        UB["UpdateBooking Handler"]:::app
        CancelB["CancelBooking Handler"]:::app
        GS["GetCampsites Handler"]:::app
        GB["GetBooking Handler"]:::app
        GV["GetVacantDates Handler"]:::app
        Val["Booking Validators"]:::app
        Dec["Logging Decorator"]:::app
    end
    click CC "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/application/command/create_campsite.go"
    click CB "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/application/command/create_booking.go"
    click UB "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/application/command/update_booking.go"
    click CancelB "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/application/command/cancel_booking.go"
    click GS "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/application/query/get_campsites.go"
    click GB "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/application/query/get_booking.go"
    click GV "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/application/query/get_vacant_dates.go"
    click Val "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/application/validator/booking_validators.go"
    click Dec "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/application/decorator/logging.go"

    %% Domain Layer
    subgraph "Domain Layer"
        CEnt["Campsite Entity"]:::domain
        BEnt["Booking Entity"]:::domain
        CRepInt["CampsiteRepository Interface"]:::domain
        BRepInt["BookingRepository Interface"]:::domain
        BValInt["BookingValidator Interface"]:::domain
    end
    click CEnt "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/domain/campsite.go"
    click BEnt "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/domain/booking.go"
    click CRepInt "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/domain/campsite_repository.go"
    click BRepInt "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/domain/booking_repository.go"
    click BValInt "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/domain/booking_validator.go"

    %% Infrastructure Layer
    subgraph "Infrastructure Layer"
        PCR["Postgres Campsite Repo"]:::infra
        PBR["Postgres Booking Repo"]:::infra
        SQLQ["SQL Queries"]:::infra
        Utils["SQL Utils"]:::infra
        ServiceComp["Service Composition"]:::infra
        Waiter["Dependency Waiter"]:::infra
    end
    click PCR "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/postgres/campsite_repository.go"
    click PBR "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/postgres/booking_repository.go"
    click SQLQ "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/postgres/sql/queries.go"
    click Utils "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/postgres/utils.go"
    click ServiceComp "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/service/service.go"
    click Waiter "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/internal/waiter/waiter.go"

    %% Database
    PostgresDB["PostgreSQL DB"]:::db

    %% DB Migrations & Init
    subgraph "DB Migrations"
        Migration1["001_create_campsites_table.sql"]:::db
        Migration2["002_create_bookings_table.sql"]:::db
        Migration3["003_alter_bookings_add_version.sql"]:::db
        InitScript["create_campgrounds_db.sh"]:::db
    end
    click Migration1 "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/db/migrations/001_create_campsites_table.sql"
    click Migration2 "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/db/migrations/002_create_bookings_table.sql"
    click Migration3 "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/db/migrations/003_alter_bookings_add_version.sql"
    click InitScript "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/db/init/create_campgrounds_db.sh"

    %% Auxiliary Tools
    DataGen["Data Generator Tool"]:::deploy
    click DataGen "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/datagenerator/main.go"

    %% Deployment & CI/CD
    subgraph "Deployment & CI/CD"
        Dockerfile["Dockerfile"]:::deploy
        Compose["docker-compose"]:::deploy
        Entryp["Entrypoint Script"]:::deploy
        K8sManifests["Kubernetes Manifests"]:::deploy
        CI1["CI Workflow"]:::deploy
        CI2["Docker Publish Workflow"]:::deploy
    end
    click Dockerfile "https://github.com/igor-baiborodine/campsite-booking-go/tree/main/docker/Dockerfile"
    click Compose "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/docker/docker-compose.yml"
    click Entryp "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/docker/docker-entrypoint.sh"
    click K8sManifests "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/k8s/campgrounds.yaml"
    click CI1 "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/.github/workflows/ci.yml"
    click CI2 "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/.github/workflows/docker-publish.yml"

    %% Tests
    TestsCon["Concurrent Tests"]:::deploy
    TestsPerf["Performance Tests"]:::deploy
    click TestsCon "https://github.com/igor-baiborodine/campsite-booking-go/tree/main/tests/concurrent/"
    click TestsPerf "https://github.com/igor-baiborodine/campsite-booking-go/blob/main/tests/perf/campgrounds_api_test.go"

    %% Connections
    Clients -->|RPC Calls| GRPC
    Startup --> Config
    Startup --> Logger
    Startup --> Waiter
    Startup --> ServiceComp
    Startup --> GRPC

    GRPC --> Interceptors
    GRPC --> ProtoStubs
    GRPC -->|Invokes| CC
    GRPC -->|Invokes| CB
    GRPC -->|Invokes| UB
    GRPC -->|Invokes| CancelB
    GRPC -->|Invokes| GS
    GRPC -->|Invokes| GB
    GRPC -->|Invokes| GV

    Interceptors --> CC
    Interceptors --> CB
    Interceptors --> UB
    Interceptors --> CancelB
    Interceptors --> GS
    Interceptors --> GB
    Interceptors --> GV
    Interceptors --> Val

    CC --> CEnt
    CB --> BEnt
    UB --> BEnt
    CancelB --> BEnt
    GS --> CEnt
    GB --> BEnt
    GV --> CEnt

    Val --> CC
    Val --> CB
    Val --> UB
    Val --> CancelB

    CEnt --> CRepInt
    BEnt --> BRepInt
    CC --> CRepInt
    CB --> BRepInt
    UB --> BRepInt
    CancelB --> BRepInt

    CRepInt --> PCR
    BRepInt --> PBR
    PCR --> SQLQ
    PBR --> SQLQ
    SQLQ --> Utils
    PCR --> PostgresDB
    PBR --> PostgresDB

    ServiceComp --> PCR
    ServiceComp --> PBR
    ServiceComp --> Val

    Waiter --> Migration1
    Waiter --> Migration2
    Waiter --> Migration3
    Waiter --> InitScript

    Clients --> DataGen

    Dockerfile --> Compose
    Compose --> Entryp
    Entryp --> Migration1
    Entryp --> Migration2
    Entryp --> Migration3

    Compose --> PostgresDB
    K8sManifests --> PostgresDB

    CI1 --> Dockerfile
    CI1 --> K8sManifests
    CI1 --> TestsCon
    CI1 --> TestsPerf

    %% Styles
    classDef external fill:#cccccc,stroke:#000,stroke-width:1px
    classDef transport fill:#b3d1ff,stroke:#000,stroke-width:1px
    classDef app fill:#b3ffb3,stroke:#000,stroke-width:1px
    classDef domain fill:#fff2b3,stroke:#000,stroke-width:1px
    classDef infra fill:#ffd9b3,stroke:#000,stroke-width:1px
    classDef db fill:#cce0ff,stroke:#000,stroke-width:1px
    classDef deploy fill:#e0b3ff,stroke:#000,stroke-width:1px
```
