# pt-sinan-akbar/split-bills-be architecture

> Architecture diagram of the GitHub repository pt-sinan-akbar/split-bills-be, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pt-sinan-akbar/split-bills-be
- Repository: https://github.com/pt-sinan-akbar/split-bills-be

## Overview

##### Project type and purpose
- This is a standalone, back-end RESTful API service (written in Go) that provides bill-splitting functionality among friends.
- There’s no bundled frontend here; the repo exposes HTTP endpoints (and a Swagger UI) for any client (web, mobile, etc.) to interact with.

##### File structure
- Top-level files:
- main.go – application entrypoint
- Dockerfile, .dockerignore – containerization
- deploy/*.yaml – Kubernetes Deployment, Service, Ingress
- .env.example, initializers/loadEnv.go – environment config
- Core code directories (layered architecture):
- routes/ → route definitions, URL→controller mappings
- controllers/ → HTTP handlers (BillController.go, BillDataController.go, etc.)
- manager/ → business logic layer (BillManager.go, BillDataManager.go, …)
- models/ → data models / ORM definitions
- dto/ → request/response structs for data transfer
- initializers/ → DB connection (connectDB.go), environment loading
- migration/, seeder/ → one-off DB migration & seed scripts
- docs/ → auto-generated Swagger definitions (swagger.json, swagger.yaml)

##### README for additional insights
- Supports live-reload via Air, Docker build/run, Kubernetes deployment.
- Exposes API docs at `/swagger/index.html`.

##### Components
a. Main components
1. Clients (Web UI, Mobile App, CLI, etc.)
2. Ingress / API Gateway (Kubernetes Ingress)
3. split-bill-service (the Go application)
- Router layer
- Controller layer
- Manager (Service) layer
- Models / ORM + Migration/Seeder
4. Database (e.g., PostgreSQL/MySQL)
5. External services (optional: logging, monitoring, Swagger UI)
b. Relationships & interactions
- Clients → Ingress → HTTP request → Router
- Router → Controller → Manager → Model → Database
- Manager returns business data back up to Controller → Router → Response to Client
- Migration & Seeder run at startup or as a separate job against the Database
c. Architectural patterns
- Layered (Router → Controller → Service/Manager → Data Access)
- MVC-style separation of concerns (controllers manage HTTP, managers handle logic, models map to DB)
- Twelve-factor app principles (env config, stateless service, containerized, separate dev & prod)
d. Key technologies
- Go modules (go.mod)
- Gin / Gorilla Mux (presumed HTTP router)
- GORM / sqlx (assumed ORM layer)
- Docker & Kubernetes for containerization & orchestration
- Swagger for API docs

##### Detailed capture of essential elements
- Break out each major controller (Bill, BillItem, BillMember, BillOwner) as sub-components if desired.
- Migration and seeder processes as separate jobs/tools that run against the same database.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Clients
    Client["Clients<br>(Web, Mobile, CLI)"]:::external

    %% Kubernetes Ingress / API Gateway
    Ingress["Kubernetes Ingress<br>(API Gateway)"]:::httpLayer

    %% Containerization & Orchestration
    subgraph "Containerization & Orchestration"
        DockerfileNode["Dockerfile & .dockerignore"]:::infra
        goMod["go.mod & go.sum"]:::infra
        subgraph "Kubernetes Artifacts"
            K8sDeployment["deploy/deployment.yaml"]:::infra
            K8sService["deploy/service.yaml"]:::infra
            K8sIngressArtifact["deploy/ingress.yaml"]:::infra
        end
    end

    %% Main Application Service
    subgraph "split-bill-service"
        main["main.go"]:::infra
        env["initializers/loadEnv.go"]:::infra
        dbInit["initializers/connectDB.go"]:::infra
        RouterLayer["Router Layer"]:::httpLayer
        ControllerLayer["Controller Layer"]:::appCode
        ManagerLayer["Manager Layer"]:::appCode
        ModelLayer["Models / ORM Definitions"]:::dataLayer
        dto["DTOs<br>(Request/Response Structs)"]:::dataLayer
        migration["Migration Scripts"]:::dataLayer
        seeder["Seeder Scripts"]:::dataLayer
        helpers["Helpers / Utilities"]:::appCode
        docs["Swagger API Documentation"]:::httpLayer
    end

    %% External Database
    DB["Database<br>(PostgreSQL/MySQL)"]:::dataLayer

    %% Data Flows
    Client --> Ingress
    Ingress -->|routes traffic| RouterLayer
    DockerfileNode -->|builds image| K8sDeployment
    K8sDeployment --> K8sService
    K8sService --> Ingress

    %% Initialization and Startup
    main --> env --> dbInit --> RouterLayer

    %% Service Layers
    RouterLayer --> ControllerLayer
    ControllerLayer --> ManagerLayer
    ManagerLayer --> ModelLayer
    ModelLayer --> DB

    %% Auxiliary Flows
    migration -->|run migrations| DB
    seeder -->|seed data| DB
    RouterLayer --> docs
    ManagerLayer --> helpers
    RouterLayer --> dto

    %% Click Events
    click RouterLayer "https://github.com/pt-sinan-akbar/split-bills-be/tree/main/routes/"
    click ControllerLayer "https://github.com/pt-sinan-akbar/split-bills-be/tree/main/controllers/"
    click ManagerLayer "https://github.com/pt-sinan-akbar/split-bills-be/tree/main/manager/"
    click ModelLayer "https://github.com/pt-sinan-akbar/split-bills-be/tree/main/models/"
    click dto "https://github.com/pt-sinan-akbar/split-bills-be/tree/main/dto/"
    click env "https://github.com/pt-sinan-akbar/split-bills-be/blob/main/initializers/loadEnv.go"
    click dbInit "https://github.com/pt-sinan-akbar/split-bills-be/blob/main/initializers/connectDB.go"
    click migration "https://github.com/pt-sinan-akbar/split-bills-be/tree/main/migration/"
    click seeder "https://github.com/pt-sinan-akbar/split-bills-be/tree/main/seeder/"
    click main "https://github.com/pt-sinan-akbar/split-bills-be/blob/main/main.go"
    click DockerfileNode "https://github.com/pt-sinan-akbar/split-bills-be/tree/main/Dockerfile"
    click goMod "https://github.com/pt-sinan-akbar/split-bills-be/blob/main/go.mod"
    click K8sDeployment "https://github.com/pt-sinan-akbar/split-bills-be/blob/main/deploy/deployment.yaml"
    click K8sService "https://github.com/pt-sinan-akbar/split-bills-be/blob/main/deploy/service.yaml"
    click K8sIngressArtifact "https://github.com/pt-sinan-akbar/split-bills-be/blob/main/deploy/ingress.yaml"
    click docs "https://github.com/pt-sinan-akbar/split-bills-be/blob/main/docs/swagger.json"
    click helpers "https://github.com/pt-sinan-akbar/split-bills-be/blob/main/helpers/utils.go"

    %% Styles
    classDef httpLayer fill:#BBDEFB,stroke:#1976D2,color:#0D47A1;
    classDef appCode fill:#C8E6C9,stroke:#2E7D32,color:#1B5E20;
    classDef dataLayer fill:#FFF9C4,stroke:#F9A825,color:#F57F17;
    classDef infra fill:#ECEFF1,stroke:#90A4AE,color:#455A64;
    classDef external fill:#FFCDD2,stroke:#C62828,color:#B71C1C;
```
