# sleede/fab-manager architecture

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

- Interactive diagram: https://gitdiagram.com/sleede/fab-manager
- Repository: https://github.com/sleede/fab-manager

## Overview

##### Project type and purpose
- Full-stack web application (Ruby on Rails backend + SPA-style front-end in TypeScript/TSX + AngularJS directives).
- Provides REST API, OpenAPI endpoints, background processing, search, payment, SSO.

- Front-End (Browser)
- Components: React/TSX modules, AngularJS directives, CSS/SCSS assets, Webpack bundle.
- Interfaces: REST API client, OpenAPI client.
- Back-End Web Tier (Rails App Server)
- Controllers (MVC & API controllers), Views (ERB, Jbuilder JSON), Service Objects, Models, Policies, Concerns, Uploaders, Validators.
- Persistence & Infrastructure
- Primary Data Store: PostgreSQL
- Full-Text Search: Elasticsearch
- Cache & Queue: Redis (Sidekiq for background jobs)
- File Storage: ActiveStorage (local/S3)
- External Services
- Payment Gateways: Stripe, Payzen (via lib/stripe and lib/pay_zen)
- SSO Providers: OAuth2, OpenID Connect, SAML (lib/omni_auth/strategies)
- Email/Scheduling: SMTP, ActionMailer, Sidekiq Workers

##### Detail relationships and data flows
- Browser → Web Tier: HTTP(S) requests to Nginx/Passenger or Puma (config/puma.rb)
- Web Tier → DB: ActiveRecord ORM calls
- Web Tier → Elasticsearch: via application code (config/initializers/elasticsearch.rb)
- Web Tier → Redis/Sidekiq: enqueue/dequeue background jobs (workers/)
- Sidekiq Workers → DB, External APIs, Email
- Web Tier → External Payment/SSO: HTTP calls through wrapper libraries (lib/stripe, lib/pay_zen, lib/omni_auth)

##### Architectural patterns
- Layered architecture: Presentation → Application (Controllers/Services) → Domain (Models/Policies) → Infrastructure
- Service-object pattern: app/services/ for business logic
- Modular front-end: component-based (app/frontend/src/javascript/components), typed API clients
- Monolithic deployment: single codebase in Docker/Vagrant (Dockerfile, Vagrantfile), CI via GitHub Actions/GitLab CI

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Front-End Layer
    subgraph "Front-End (Browser)"
        FE_UIComp["UI Components"]:::frontend
        FE_Directives["AngularJS Directives"]:::frontend
        FE_Controllers["UI Controllers"]:::frontend
        FE_APIClients["API Clients & Typed Interfaces"]:::frontend
        FE_Build["Build & Bundling"]:::frontend
        FE_Styles["CSS/SCSS Assets"]:::frontend
    end

    %% Web Tier Layer
    subgraph "Web Tier (Rails App)"
        Controllers["Controllers (MVC & API)"]:::app
        APIControllers["Internal API Controllers"]:::app
        OpenAPIControllers["Public OpenAPI Controllers"]:::app
        Views["Views & JSON Builders"]:::app
        Services["Service Objects"]:::app
        Models["ActiveRecord Models"]:::app
        Policies["Policy Objects"]:::app
        Workers["Background Jobs & Workers"]:::app
        Uploaders["Uploaders"]:::app
        Validators["Validators"]:::app
    end

    %% Infrastructure & Config
    subgraph "Application Config & Infrastructure"
        Puma["Puma Server"]:::infra
        ElasticsearchCfg["Elasticsearch Client Config"]:::infra
        SidekiqCfg["Sidekiq Config"]:::infra
        ActiveStorageCfg["ActiveStorage Config"]:::infra
        Routes["Routes"]:::infra
        Migrations["DB Migrations & Schema"]:::infra
        DockerVagrant["Docker/Vagrant & CI"]:::infra
        Locales["Localization & I18n"]:::infra
    end

    %% Data Stores
    subgraph "Persistence & Data Stores"
        PostgreSQL["PostgreSQL"]:::db
        Elasticsearch["Elasticsearch"]:::db
        Redis["Redis (Sidekiq)"]:::db
    end

    %% External Services
    subgraph "External Services"
        Stripe["Stripe Gateway"]:::ext
        Payzen["PayZen Gateway"]:::ext
        PaymentHelpers["Generic Payment Helpers"]:::ext
        OmniStrategies["OmniAuth Strategies"]:::ext
        OAuthProviders["OAuth2/OpenID/SAML Providers"]:::ext
        SMTP["SMTP / Email (ActionMailer)"]:::ext
        S3Storage["S3 / File Storage"]:::ext
    end

    %% Data Flows
    FE_APIClients -->|"HTTP(S) Requests"| Controllers
    Controllers -->|"invoke"| Services
    Services -->|"use"| Models
    Models -->|"ORM Calls"| PostgreSQL
    Controllers -->|"render"| Views
    Services -->|"enqueue"| Workers
    Controllers -->|"require"| Policies
    Controllers -->|"upload"| Uploaders
    Validators -->|"validate"| Models

    Controllers -->|"search"| Elasticsearch
    Controllers -->|"cache|queue"| Redis
    Workers -->|"read/write"| PostgreSQL
    Workers -->|"send email"| SMTP
    Workers -->|"call external payment"| Stripe
    Workers -->|"call external payment"| Payzen
    Services -->|"use helpers"| PaymentHelpers
    Controllers -->|"SSO Auth"| OAuthProviders
    Controllers -->|"SSO Strategies"| OmniStrategies
    Controllers -->|"store files"| S3Storage

    %% Infrastructure Connections
    Controllers -->|"/api/routes"| Routes
    Controllers -->|"app server"| Puma
    Services -->|"config load"| ElasticsearchCfg
    Workers -->|"config load"| SidekiqCfg
    Uploaders -->|"config load"| ActiveStorageCfg
    Controllers -->|"i18n"| Locales
    Migrations -->|"defines"| PostgreSQL
    DockerVagrant -->|"deploys"| Controllers

    %% Click Events for Component Mapping
    click FE_UIComp "https://github.com/sleede/fab-manager/tree/master/app/frontend/src/javascript/components"
    click FE_Directives "https://github.com/sleede/fab-manager/tree/master/app/frontend/src/javascript/directives"
    click FE_Controllers "https://github.com/sleede/fab-manager/tree/master/app/frontend/src/javascript/controllers"
    click FE_APIClients "https://github.com/sleede/fab-manager/tree/master/app/frontend/src/javascript/api"
    click FE_Build "https://github.com/sleede/fab-manager/blob/master/config/webpack/webpack.config.js"
    click FE_Build "https://github.com/sleede/fab-manager/tree/master/bin/webpack"
    click FE_Build "https://github.com/sleede/fab-manager/blob/master/babel.config.js"
    click FE_Build "https://github.com/sleede/fab-manager/blob/master/tsconfig.json"
    click FE_Styles "https://github.com/sleede/fab-manager/tree/master/app/frontend/src/stylesheets"

    click Controllers "https://github.com/sleede/fab-manager/tree/master/app/controllers"
    click APIControllers "https://github.com/sleede/fab-manager/tree/master/app/controllers/api"
    click OpenAPIControllers "https://github.com/sleede/fab-manager/tree/master/app/controllers/open_api/v1"
    click Views "https://github.com/sleede/fab-manager/tree/master/app/views"
    click Views "https://github.com/sleede/fab-manager/tree/master/app/views/api"
    click Views "https://github.com/sleede/fab-manager/tree/master/app/views/open_api/v1"
    click Services "https://github.com/sleede/fab-manager/tree/master/app/services"
    click Models "https://github.com/sleede/fab-manager/tree/master/app/models"
    click Policies "https://github.com/sleede/fab-manager/tree/master/app/policies"
    click Workers "https://github.com/sleede/fab-manager/tree/master/app/workers"
    click Uploaders "https://github.com/sleede/fab-manager/tree/master/app/uploaders"
    click Validators "https://github.com/sleede/fab-manager/tree/master/app/validators"

    click Puma "https://github.com/sleede/fab-manager/blob/master/config/puma.rb"
    click ElasticsearchCfg "https://github.com/sleede/fab-manager/blob/master/config/initializers/elasticsearch.rb"
    click SidekiqCfg "https://github.com/sleede/fab-manager/blob/master/config/initializers/sidekiq.rb"
    click SidekiqCfg "https://github.com/sleede/fab-manager/blob/master/config/sidekiq.yml"
    click ActiveStorageCfg "https://github.com/sleede/fab-manager/blob/master/config/storage.yml"
    click Routes "https://github.com/sleede/fab-manager/blob/master/config/routes.rb"
    click Migrations "https://github.com/sleede/fab-manager/tree/master/db/migrate"
    click Migrations "https://github.com/sleede/fab-manager/blob/master/db/schema.rb"
    click DockerVagrant "https://github.com/sleede/fab-manager/tree/master/Dockerfile"
    click DockerVagrant "https://github.com/sleede/fab-manager/tree/master/Vagrantfile"
    click DockerVagrant "https://github.com/sleede/fab-manager/blob/master/.gitlab-ci.yml"
    click DockerVagrant "https://github.com/sleede/fab-manager/tree/master/.github/workflows/"
    click Locales "https://github.com/sleede/fab-manager/tree/master/config/locales"

    click Stripe "https://github.com/sleede/fab-manager/tree/master/lib/stripe"
    click Payzen "https://github.com/sleede/fab-manager/tree/master/lib/pay_zen"
    click PaymentHelpers "https://github.com/sleede/fab-manager/tree/master/lib/payment"
    click OmniStrategies "https://github.com/sleede/fab-manager/tree/master/lib/omni_auth/strategies"
    click OAuthProviders "https://github.com/sleede/fab-manager/blob/master/lib/omni_auth/oauth2.rb"
    click OAuthProviders "https://github.com/sleede/fab-manager/blob/master/lib/omni_auth/openid_connect.rb"
    click OAuthProviders "https://github.com/sleede/fab-manager/blob/master/lib/omni_auth/saml.rb"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#004085,color:#004085
    classDef app fill:#d4edda,stroke:#155724,color:#155724
    classDef infra fill:#fff3cd,stroke:#856404,color:#856404
    classDef db fill:#f8d7da,stroke:#721c24,color:#721c24
    classDef ext fill:#f5c6cb,stroke:#721c24,color:#721c24
```
