# it0dan/golang-studies architecture

> Architecture diagram of the GitHub repository it0dan/golang-studies, 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/it0dan/golang-studies
- Repository: https://github.com/it0dan/golang-studies

## Overview

##### Project type and purpose
- This is a standalone backend REST API service written in Go (“golang-studies”) whose sole purpose is to expose HTTP endpoints (via Gin Gonic) and persist/fetch data to PostgreSQL.
- It is containerized (Docker/Docker Compose) for easy deployment, and uses SQL migrations to initialize its schema.

##### File structure
- Top-level
- build/ – contains Dockerfile and docker-compose.yaml
- cmd/api/main.go – the application entrypoint
- internal/ – application code not exposed to users
- server/handlers.go – HTTP handler functions
- models/customer.go – domain model definitions
- pkg/db/pgsql/db_conn.go – database connection logic
- migrations/migrations.sql – schema setup
- This follows a typical Go “project layout” with cmd/, internal/ for core logic, pkg/ for reusable packages, and build/ for ops.

##### README
- Confirms: Gin Gonic REST API + PostgreSQL in container.
- No additional architectural description, so we infer a classic client→API→DB flow.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Client
    Client["External Client"]:::external

    %% Docker Compose Layer
    subgraph "Docker Compose Layer"
        direction TB
        ComposeFile["docker-compose.yaml"]:::infra
        Dockerfile["Dockerfile"]:::infra
        ComposeFile -->|"starts"| APIContainer
        ComposeFile -->|"starts"| DB
    end

    %% API Container
    subgraph "API Container"
        direction TB
        Main["Gin HTTP Server"]:::api
        Handlers["Handlers"]:::api
        Models["Models"]:::api
        DBConn["DB Connector"]:::api
        Main -->|"routes requests"| Handlers
        Handlers -->|"uses domain models"| Models
        Handlers -->|"calls connector"| DBConn
    end

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

    %% Migrations Job
    subgraph "Migrations"
        direction TB
        Migrations["Migrations"]:::infra
        Migrations -->|"schema setup"| DB
    end

    %% Data Flows
    Client -->|"HTTP Request"| Main
    DBConn -->|"Execute SQL"| DB

    %% Click Events
    click Main "https://github.com/it0dan/golang-studies/blob/main/cmd/api/main.go"
    click Handlers "https://github.com/it0dan/golang-studies/blob/main/internal/server/handlers.go"
    click Models "https://github.com/it0dan/golang-studies/blob/main/internal/models/customer.go"
    click DBConn "https://github.com/it0dan/golang-studies/blob/main/pkg/db/pgsql/db_conn.go"
    click Migrations "https://github.com/it0dan/golang-studies/blob/main/migrations/migrations.sql"
    click Dockerfile "https://github.com/it0dan/golang-studies/tree/main/build/Dockerfile"
    click ComposeFile "https://github.com/it0dan/golang-studies/blob/main/build/docker-compose.yaml"

    %% Styles
    classDef api fill:#D0E8FF,stroke:#0288D1,color:#000,font-weight:bold
    classDef infra fill:#E8F5E9,stroke:#388E3C,color:#000,font-weight:bold
    classDef external fill:#FFF3E0,stroke:#FB8C00,color:#000,font-weight:bold
    classDef db fill:#E1F5FE,stroke:#0277BD,color:#000,font-weight:bold
    class APIContainer infra
    class DB infra
```
