# funktionalio/pillars architecture

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

- Interactive diagram: https://gitdiagram.com/funktionalio/pillars
- Repository: https://github.com/funktionalio/pillars

## Overview

##### Main Components Identification

The system should be represented with these core components:

a. Core Framework Components:
- API Server (ApiServer.scala)
- Admin Server (AdminServer.scala)
- Configuration Management (Config.scala)
- Observability System (Observability.scala)
- Logging System (Logging.scala)
- Metrics Collection (Metrics.scala)
- Tracing System (Traces.scala)

b. Database Components:
- Doobie Integration (db-doobie module)
- Skunk Integration (db-skunk module)
- Migration System (db-migration module)

c. Integration Components:
- HTTP Client (http-client module)
- Redis Integration (redis-rediculous module)
- RabbitMQ Integration (rabbitmq-fs2 module)
- Feature Flags System (flags module)

**┌─────────────────────────────────────────────────────────────┐**
- Pillars Framework                       │
- ┬─────────────────────┬─────────────────────┤
- Core Layer   │  Integration Layer  │    Database Layer   │
- ┼─────────────────────┼─────────────────────┤
- API Server  │ - HTTP Client       │ - Doobie           │
- Admin Server│ - Redis Client      │ - Skunk            │
- Config      │ - RabbitMQ Client   │ - Migrations      │
- Logging     │ - Feature Flags     │                    │
- Metrics     │                     │                    │
- Traces      │                     │                    │
- ┴─────────────────────┴─────────────────────┘

Following relationships:

##### Additional Elements

Supporting elements:
- Configuration flow paths
- Observability data paths
- External service connections
- Module dependencies

##### Notes

Technical notes for:
- Scala 3 specific features
- TypeLevel stack integration points
- Extension points for custom modules
- Configuration requirements

Remember to include version information and any relevant TypeLevel stack dependencies in supplementary documentation.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core["Core Layer"]
        API[API Server]
        ADMIN[Admin Server]
        CONFIG[Configuration]
        OBS[Observability]
        LOG[Logging]
        METRICS[Metrics]
        TRACES[Traces]
    end

    subgraph Integration["Integration Layer"]
        HTTP[HTTP Client]
        REDIS[Redis Client]
        RABBIT[RabbitMQ Client]
        FLAGS[Feature Flags]
    end

    subgraph Database["Database Layer"]
        DOOBIE[Doobie]
        SKUNK[Skunk]
        MIGRATIONS[Migrations]
    end

    %% Core Layer Relationships
    CONFIG --> API
    CONFIG --> ADMIN
    OBS --> LOG
    OBS --> METRICS
    OBS --> TRACES
    API --> OBS
    ADMIN --> OBS

    %% Integration Layer Dependencies
    API --> HTTP
    API --> REDIS
    API --> RABBIT
    API --> FLAGS
    ADMIN --> HTTP
    ADMIN --> FLAGS

    %% Database Layer Dependencies
    API --> DOOBIE
    API --> SKUNK
    MIGRATIONS --> DOOBIE
    MIGRATIONS --> SKUNK

    %% Styling
    classDef core fill:#b3d1ff,stroke:#9999ff
    classDef integration fill:#b3ffb3,stroke:#99ff99
    classDef database fill:#ffd9b3,stroke:#ffcc99

    class API,ADMIN,CONFIG,OBS,LOG,METRICS,TRACES core
    class HTTP,REDIS,RABBIT,FLAGS integration
    class DOOBIE,SKUNK,MIGRATIONS database

    %% Click Events
    click API "https://github.com/FunktionalIO/pillars/blob/main/modules/core/src/main/scala/pillars/ApiServer.scala"
    click ADMIN "https://github.com/FunktionalIO/pillars/blob/main/modules/core/src/main/scala/pillars/AdminServer.scala"
    click CONFIG "https://github.com/FunktionalIO/pillars/blob/main/modules/core/src/main/scala/pillars/Config.scala"
    click OBS "https://github.com/FunktionalIO/pillars/blob/main/modules/core/src/main/scala/pillars/Observability.scala"
    click LOG "https://github.com/FunktionalIO/pillars/blob/main/modules/core/src/main/scala/pillars/Logging.scala"
    click METRICS "https://github.com/FunktionalIO/pillars/blob/main/modules/core/src/main/scala/pillars/Metrics.scala"
    click TRACES "https://github.com/FunktionalIO/pillars/blob/main/modules/core/src/main/scala/pillars/Traces.scala"
    click DOOBIE "https://github.com/FunktionalIO/pillars/blob/main/modules/db-doobie/src/main/scala/pillars/db_doobie/db.scala"
    click SKUNK "https://github.com/FunktionalIO/pillars/blob/main/modules/db-skunk/src/main/scala/pillars/db/db.scala"
    click MIGRATIONS "https://github.com/FunktionalIO/pillars/blob/main/modules/db-migration/src/main/scala/pillars/db/migrations/migrations.scala"
    click HTTP "https://github.com/FunktionalIO/pillars/blob/main/modules/http-client/src/main/scala/pillars/httpclient/httpclient.scala"
    click REDIS "https://github.com/FunktionalIO/pillars/blob/main/modules/redis-rediculous/src/main/scala/pillars/redis_rediculous/redis.scala"
    click RABBIT "https://github.com/FunktionalIO/pillars/blob/main/modules/rabbitmq-fs2/src/main/scala/pillars/rabbitmq/fs2/rabbitmq.scala"
    click FLAGS "https://github.com/FunktionalIO/pillars/blob/main/modules/flags/src/main/scala/pillars/flags/FeatureFlags.scala"
```
