# msayib/fibernote architecture

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

- Interactive diagram: https://gitdiagram.com/msayib/fibernote
- Repository: https://github.com/msayib/fibernote

## Overview

##### Project type and purpose
- This is a backend‐only RESTful API (“Note App”) written in Go.
- It uses Go Fiber for the HTTP server, GORM for ORM/database access, and Viper for configuration.
- Its sole purpose is to expose CRUD endpoints for “notes.”

##### File structure
- main.go: entry point that ties everything together.
- controllers/note.controller.go: HTTP handlers (CRUD).
- models/note.model.go: GORM model definition for Note.
- initializers/loadEnv.go: reads environment variables via Viper.
- initializers/db.go: sets up the DB connection via GORM.
- docker-compose.yml + app.env.example: containerized database and examples of environment variables.
- go.mod/go.sum, .gitignore, README.md: metadata and configuration.

##### README for additional insights
- Confirms usage of Go Fiber, GORM, and Viper.
- Mentions “air” (live‐reload) for development.

##### Final Recommendations
- Be exhaustive in component separation: show the Viper config loader and Docker Compose as distinct modules.
- Environment file → Viper → DB connection under a “Configuration” cluster.
- Don’t overthink—break the system into all logical pieces so stakeholders see exactly how requests travel through the app.

## Diagram (Mermaid)

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

    %% Configuration & Orchestration
    subgraph "Configuration & Orchestration"
        Env["app.env.example"]:::config
        Viper["Viper Config Loader\n(initializers/loadEnv.go)\nViper v1.x"]:::config
        Compose["Docker Compose\n(docker-compose.yml)"]:::config
        DBContainer["Postgres DB Container"]:::data
    end

    %% Initialization Sequence
    subgraph "Initialization"
        Main["main.go\n(API Gateway Startup)"]:::http
        DBInit["Database Initializer\n(initializers/db.go)\nGORM v1.x"]:::data
    end

    %% Runtime Layers
    subgraph "HTTP Layer"
        Router["Fiber Router\n(Go Fiber v2.x)"]:::http
        Controller["Note Controller\n(controllers/note.controller.go)"]:::http
    end

    subgraph "Data Layer"
        Model["Note Model\n(models/note.model.go)"]:::data
        Database["Postgres DB"]:::data
    end

    %% Metadata & Docs
    subgraph "Project Metadata"
        Module["Module Definitions\n(go.mod, go.sum)"]:::meta
        Readme["README.md"]:::meta
        Gitignore[".gitignore"]:::meta
    end

    %% Development Tool
    Air["air (Live Reload)"]:::config

    %% Initialization Flow
    Main -->|reads| Env
    Main -->|calls| Viper
    Viper -->|loads config| DBInit
    Compose -->|orchestrates| DBContainer
    DBInit -->|connects| DBContainer
    Main -->|initializes| DBInit
    Main -->|starts| Router

    %% Request Flow
    Client -->|HTTP Request| Router
    Router -->|routes to| Controller
    Controller -->|calls| Model
    Model -->|executes SQL| Database
    Database -->|responds| Model
    Model -->|returns| Controller
    Controller -->|HTTP Response| Client

    %% Development Tool Flow
    Air -->|watches| Main

    %% Click Events
    click Main "https://github.com/msayib/fibernote/blob/master/main.go"
    click Controller "https://github.com/msayib/fibernote/blob/master/controllers/note.controller.go"
    click Model "https://github.com/msayib/fibernote/blob/master/models/note.model.go"
    click Viper "https://github.com/msayib/fibernote/blob/master/initializers/loadEnv.go"
    click DBInit "https://github.com/msayib/fibernote/blob/master/initializers/db.go"
    click Compose "https://github.com/msayib/fibernote/blob/master/docker-compose.yml"
    click Env "https://github.com/msayib/fibernote/blob/master/app.env.example"
    click Module "https://github.com/msayib/fibernote/blob/master/go.mod"
    click Readme "https://github.com/msayib/fibernote/blob/master/README.md"
    click Gitignore "https://github.com/msayib/fibernote/blob/master/.gitignore"

    %% Styles
    classDef http fill:#BBDEFB,stroke:#1976D2,color:#0D47A1;
    classDef data fill:#C8E6C9,stroke:#2E7D32,color:#1B5E20;
    classDef config fill:#E0E0E0,stroke:#616161,color:#212121;
    classDef meta fill:#FFF9C4,stroke:#F9A825,color:#F57F17;
    classDef external fill:#FFCCBC,stroke:#D84315,color:#BF360C;
```
