# pch/rails-boilerplate architecture

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

- Interactive diagram: https://gitdiagram.com/pch/rails-boilerplate
- Repository: https://github.com/pch/rails-boilerplate

## Overview

##### Project Type and Core Components

a. Web Application Layer
- Rails MVC Architecture
- Authentication System
- Asset Pipeline
- Background Jobs

b. External Services/Dependencies
- Geocoding Service
- Sidekiq for background processing
- Database (PostgreSQL implied by structure)

##### Key Architectural Elements

Frontend Layer:
- Asset Pipeline (Propshaft)
- CSS (PostCSS)
- JavaScript (esbuild)
- Stimulus Controllers
- Turbo

Application Layer:
- Controllers (especially Users namespace)
- Models with Encryption
- Mailers
- Views (ERB templates)
- Background Jobs

Data Layer:
- PostgreSQL Database
- Active Record Encryption
- BasedUUID Implementation

Services:
- Sidekiq Worker
- Geocoding Service
- Mailer Service

**Client Layer**
- ↓
**Frontend Assets/UI**
- ↓
**Application Layer (Rails)**
- ↓
**Services Layer**
- ↓
**Data Layer**

##### Specific Components to Highlight

Authentication Flow:
- Relationship between Users::SessionsController, Users::Authentication concern, and the User model
- Encryption flow for sensitive data (name, email, IP)
- Session management and activity tracking

Background Processing:
- Sidekiq worker connection
- GeocodeActivityJob flow
- Mailer job processing

##### Important Relationships

- User authentication flow
- Session management
- Activity tracking
- Geocoding process
- Mailer system
- Asset compilation pipeline

##### Specific Implementation Details

- Active Record Encryption for sensitive data
- Session management with revocation capability
- IP-based activity tracking with geocoding
- Background job processing with Sidekiq
- Mailer system for user communications
- Asset processing pipeline

##### Additional Notes

Elements in a notes section:
- Configuration requirements (credentials, encryption keys)
- External service dependencies
- Security implementations
- Scaling considerations

Remember to highlight the modular nature of the boilerplate, showing how components can be modified or removed based on specific project needs.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        Browser["Web Browser"]
    end

    subgraph Frontend
        Assets["Asset Pipeline"]:::frontend
        click Assets "https://github.com/pch/rails-boilerplate/blob/main/app/assets/config/manifest.js"
        CSS["PostCSS Styles"]:::frontend
        click CSS "https://github.com/pch/rails-boilerplate/blob/main/app/assets/stylesheets/application.postcss.css"
        JS["JavaScript (esbuild)"]:::frontend
        click JS "https://github.com/pch/rails-boilerplate/blob/main/app/javascript/application.js"
        Stimulus["Stimulus Controllers"]:::frontend
        click Stimulus "https://github.com/pch/rails-boilerplate/tree/main/app/javascript/controllers/"
        Turbo["Turbo Drive"]:::frontend
    end

    subgraph "Application Layer"
        direction TB
        AuthSystem["Authentication System"]:::auth
        click AuthSystem "https://github.com/pch/rails-boilerplate/blob/main/app/controllers/concerns/authentication.rb"
        UserAuth["User Authentication"]:::auth
        click UserAuth "https://github.com/pch/rails-boilerplate/blob/main/app/models/concerns/users/authentication.rb"
        SessionMgmt["Session Management"]:::auth
        click SessionMgmt "https://github.com/pch/rails-boilerplate/blob/main/app/models/users/session.rb"
        ActivityTrack["Activity Tracking"]:::auth
        click ActivityTrack "https://github.com/pch/rails-boilerplate/blob/main/app/models/users/activity.rb"
        
        UserModel["User Model"]:::model
        click UserModel "https://github.com/pch/rails-boilerplate/blob/main/app/models/user.rb"
        
        Controllers["Controllers"]:::controller
        SessionController["Sessions Controller"]:::controller
        click SessionController "https://github.com/pch/rails-boilerplate/blob/main/app/controllers/users/sessions_controller.rb"
        SignupController["Signup Controller"]:::controller
        click SignupController "https://github.com/pch/rails-boilerplate/blob/main/app/controllers/users/signups_controller.rb"
        PasswordController["Password Reset Controller"]:::controller
        click PasswordController "https://github.com/pch/rails-boilerplate/blob/main/app/controllers/users/password_resets_controller.rb"
        
        Views["View Templates"]:::view
        click Views "https://github.com/pch/rails-boilerplate/tree/main/app/views/users/"
        LayoutView["Layout"]:::view
        click LayoutView "https://github.com/pch/rails-boilerplate/blob/main/app/views/layouts/application.html.erb"
        SessionView["Session Views"]:::view
        click SessionView "https://github.com/pch/rails-boilerplate/tree/main/app/views/users/sessions/"
    end

    subgraph "Services Layer"
        Sidekiq["Sidekiq Worker"]:::service
        click Sidekiq "https://github.com/pch/rails-boilerplate/blob/main/config/sidekiq.yml"
        GeocodeJob["Geocode Activity Job"]:::job
        click GeocodeJob "https://github.com/pch/rails-boilerplate/blob/main/app/jobs/users/geocode_activity_job.rb"
        Geocoder["Geocoding Service"]:::service
        click Geocoder "https://github.com/pch/rails-boilerplate/blob/main/config/initializers/geocoder.rb"
        
        Mailer["User Mailer"]:::service
        click Mailer "https://github.com/pch/rails-boilerplate/blob/main/app/mailers/user_mailer.rb"
        MailerTemplates["Email Templates"]:::view
        click MailerTemplates "https://github.com/pch/rails-boilerplate/tree/main/app/views/user_mailer/"
        MailerLayout["Mailer Layout"]:::view
        click MailerLayout "https://github.com/pch/rails-boilerplate/blob/main/app/views/layouts/mailer.html.erb"
    end

    subgraph "Data Layer"
        DB[(PostgreSQL)]:::database
        click DB "https://github.com/pch/rails-boilerplate/blob/main/config/database.yml"
        Encryption["Active Record Encryption"]:::security
    end

    %% Relationships
    Browser --> Assets
    Assets --> CSS & JS & Stimulus & Turbo
    
    Browser --> Controllers
    Controllers --> AuthSystem
    AuthSystem --> UserAuth
    UserAuth --> UserModel
    UserModel --> SessionMgmt
    SessionMgmt --> ActivityTrack
    
    Controllers --> Views
    Views --> LayoutView
    Controllers --> SessionView
    
    ActivityTrack --> GeocodeJob
    GeocodeJob --> Sidekiq
    Sidekiq --> Geocoder
    
    Controllers --> Mailer
    Mailer --> MailerTemplates
    MailerTemplates --> MailerLayout
    
    UserModel --> DB
    UserModel --> Encryption

    %% Styles
    classDef frontend fill:#a8d5ff
    classDef auth fill:#ffb366
    classDef model fill:#85b37c
    classDef controller fill:#b8860b
    classDef view fill:#d3d3d3
    classDef service fill:#98fb98
    classDef job fill:#dda0dd
    classDef database fill:#c0c0c0
    classDef security fill:#ff6b6b

    %% Legend
    subgraph Legend
        Frontend_["Frontend"]:::frontend
        Auth_["Authentication"]:::auth
        Model_["Models"]:::model
        Controller_["Controllers"]:::controller
        View_["Views"]:::view
        Service_["Services"]:::service
        Job_["Background Jobs"]:::job
        Database_["Database"]:::database
        Security_["Security"]:::security
    end
```
