# dcowett/finance-tracker architecture

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

- Interactive diagram: https://gitdiagram.com/dcowett/finance-tracker
- Repository: https://github.com/dcowett/finance-tracker

## Overview

##### Project type and purpose
- This is a Ruby on Rails full-stack web application.
- It provides user authentication (via Devise), lets users browse stocks, add them to their portfolio (UserStock), and view/update their positions.
- It uses MVC, Webpacker for JavaScript, Sprockets for CSS/assets, ActionCable for real-time channels, ActiveJob for background tasks, and ActiveMailer for email.

##### File structure
- app/
- controllers/ – Rails controllers (Welcome, Stocks, UserStocks, Users, Devise controllers)
- models/ – ActiveRecord models (User, Stock, UserStock)
- views/ – ERB templates for pages and Devise workflows
- assets/stylesheets & javascript/packs – client-side code via Sprockets & Webpacker
- channels/ – ActionCable channel definitions for WebSocket streams
- jobs/ – background job definitions
- mailers/ – email templates
- config/ – routes, database.yml, cable.yml, initializers (Devise, assets, security), webpacker config
- db/ – migrations, schema, seeds
- bin/ – Rails, Webpack, Yarn executables
- test/ – system, controller, model, channel tests
- Gemfile – Ruby gems including Rails, Devise, Webpacker, etc.
- package.json & postcss.config.js – front-end dependencies (e.g., Bootstrap)

##### README
- Placeholder. Confirms Rails 6 + Bootstrap 4, Devise, typical setup steps.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Entities
    Browser("Web Client (Browser)"):::external
    WebServer("Web Server (Puma/Nginx)"):::external
    StockAPI("External Stock API"):::cloud
    SMTP("SMTP Service"):::cloud
    Redis("Redis (Cache/PubSub)"):::cloud

    %% Web Client Layer
    subgraph "Web Client"  
        JS["JavaScript Packs"]:::frontend
        CSS["Stylesheets"]:::frontend
        Consumer["ActionCable Consumer"]:::frontend
    end

    %% Rails Application Layer
    subgraph "Rails Application"  
        Router["Rails Router"]:::backend
        subgraph "Controllers"  
            WelcomeCtrl["WelcomeController"]:::backend
            StocksCtrl["StocksController"]:::backend
            UserStocksCtrl["UserStocksController"]:::backend
            UsersCtrl["UsersController"]:::backend
            DeviseInit["Devise Initializer"]:::backend
        end
        subgraph "Views"  
            Layouts["Application Layout & Partials"]:::backend
            WelcomeView["Welcome Pages"]:::backend
            StocksView["Stocks Views"]:::backend
            PortfolioView["Portfolio Views"]:::backend
            DeviseViews["Devise Workflows"]:::backend
        end
        subgraph "Models"  
            ApplicationRecord["ApplicationRecord"]:::backend
            UserModel["User Model"]:::backend
            StockModel["Stock Model"]:::backend
            UserStockModel["UserStock Model"]:::backend
        end
        subgraph "ActionCable Server"  
            ACConnection["Connection & Channel Setup"]:::backend
            ACChannels["Custom Channels"]:::backend
        end
        subgraph "Background Jobs"  
            ApplicationJob["Application Job"]:::async
            JobsDir["Job Definitions"]:::async
        end
        subgraph "Mailers"  
            ApplicationMailer["Application Mailer"]:::async
            MailerViews["Mailer Templates"]:::async
        end
        subgraph "Asset Pipeline"  
            Sprockets["Sprockets Manifest"]:::backend
            WebpackerCfg["Webpacker Config"]:::backend
        end
        subgraph "Database Config & Migrations"  
            DBConfig["DB Settings"]:::backend
            Schema["Schema"]:::backend
            Migrations["Migrations"]:::backend
        end
        subgraph "ActionCable Config"  
            CableCfg["Cable Settings"]:::backend
        end
        subgraph "Authentication (Devise)"  
            DeviseInit2["Devise Initializer"]:::backend
            DeviseMigrations["Devise Migrations"]:::backend
        end
    end

    %% Data Store
    Postgres[(PostgreSQL)]:::db

    %% Flows
    Browser -->|HTTP Request| WebServer
    WebServer -->|forwards| Router
    Router -->|routes to| WelcomeCtrl
    Router -->|routes to| StocksCtrl
    Router -->|routes to| UserStocksCtrl
    Router -->|routes to| UsersCtrl
    WelcomeCtrl -->|uses| ApplicationRecord
    StocksCtrl -->|uses| StockModel
    UserStocksCtrl -->|uses| UserStockModel
    UsersCtrl -->|uses| UserModel
    ApplicationRecord -->|queries| Postgres
    StockModel -->|queries| Postgres
    UserStockModel -->|queries| Postgres
    UserModel -->|queries| Postgres
    WelcomeCtrl -->|renders| WelcomeView
    StocksCtrl -->|renders| StocksView
    UserStocksCtrl -->|renders| PortfolioView
    UsersCtrl -->|renders| DeviseViews
    Router -->|serves assets| Sprockets
    Router -->|serves assets| WebpackerCfg
    Browser -->|loads| JS
    Browser -->|loads| CSS

    Browser -->|WebSocket| Consumer
    Consumer -->|connects| ACConnection
    ACConnection -->|subscribes| ACChannels
    ACChannels -->|publishes| Consumer

    WelcomeCtrl -->|enqueues| ApplicationJob
    StocksCtrl -->|enqueues| JobsDir
    ApplicationJob -->|executes| JobsDir
    JobsDir -->|writes| Postgres
    ApplicationJob -->|sends mail| ApplicationMailer
    ApplicationMailer -->|delivers via| SMTP

    ACConnection -->|pub/sub| Redis
    JobsDir -->|uses| Redis

    StocksCtrl -->|calls| StockAPI

    %% Click Events
    click JS "https://github.com/dcowett/finance-tracker/blob/main/app/javascript/packs/application.js"
    click CSS "https://github.com/dcowett/finance-tracker/tree/main/app/assets/stylesheets"
    click Consumer "https://github.com/dcowett/finance-tracker/blob/main/app/javascript/channels/consumer.js"
    click Router "https://github.com/dcowett/finance-tracker/blob/main/config/routes.rb"
    click WelcomeCtrl "https://github.com/dcowett/finance-tracker/blob/main/app/controllers/welcome_controller.rb"
    click StocksCtrl "https://github.com/dcowett/finance-tracker/blob/main/app/controllers/stocks_controller.rb"
    click UserStocksCtrl "https://github.com/dcowett/finance-tracker/blob/main/app/controllers/user_stocks_controller.rb"
    click UsersCtrl "https://github.com/dcowett/finance-tracker/blob/main/app/controllers/users_controller.rb"
    click DeviseInit "https://github.com/dcowett/finance-tracker/blob/main/config/initializers/devise.rb"
    click Layouts "https://github.com/dcowett/finance-tracker/tree/main/app/views/layouts"
    click WelcomeView "https://github.com/dcowett/finance-tracker/blob/main/app/views/welcome/index.html.erb"
    click StocksView "https://github.com/dcowett/finance-tracker/blob/main/app/views/stocks/_list.html.erb"
    click PortfolioView "https://github.com/dcowett/finance-tracker/blob/main/app/views/users/my_portfolio.html.erb"
    click DeviseViews "https://github.com/dcowett/finance-tracker/tree/main/app/views/devise"
    click ApplicationRecord "https://github.com/dcowett/finance-tracker/blob/main/app/models/application_record.rb"
    click UserModel "https://github.com/dcowett/finance-tracker/blob/main/app/models/user.rb"
    click StockModel "https://github.com/dcowett/finance-tracker/blob/main/app/models/stock.rb"
    click UserStockModel "https://github.com/dcowett/finance-tracker/blob/main/app/models/user_stock.rb"
    click ACConnection "https://github.com/dcowett/finance-tracker/blob/main/app/channels/application_cable/connection.rb"
    click ACChannels "https://github.com/dcowett/finance-tracker/tree/main/app/channels"
    click ApplicationJob "https://github.com/dcowett/finance-tracker/blob/main/app/jobs/application_job.rb"
    click JobsDir "https://github.com/dcowett/finance-tracker/tree/main/app/jobs"
    click ApplicationMailer "https://github.com/dcowett/finance-tracker/blob/main/app/mailers/application_mailer.rb"
    click MailerViews "https://github.com/dcowett/finance-tracker/blob/main/app/views/layouts/mailer.html.erb"
    click Sprockets "https://github.com/dcowett/finance-tracker/blob/main/app/assets/config/manifest.js"
    click WebpackerCfg "https://github.com/dcowett/finance-tracker/blob/main/config/webpacker.yml"
    click DBConfig "https://github.com/dcowett/finance-tracker/blob/main/config/database.yml"
    click Schema "https://github.com/dcowett/finance-tracker/blob/main/db/schema.rb"
    click Migrations "https://github.com/dcowett/finance-tracker/tree/main/db/migrate"
    click CableCfg "https://github.com/dcowett/finance-tracker/blob/main/config/cable.yml"
    click DeviseInit2 "https://github.com/dcowett/finance-tracker/blob/main/config/initializers/devise.rb"
    click DeviseMigrations "https://github.com/dcowett/finance-tracker/blob/main/db/migrate/20201215160327_devise_create_users.rb"

    %% Styles
    classDef frontend fill:#FFD580,stroke:#333,stroke-width:1px;
    classDef backend fill:#AFE1AF,stroke:#333,stroke-width:1px;
    classDef db fill:#85C1E9,stroke:#333,stroke-width:1px;
    classDef external fill:#F5B7B1,stroke:#333,stroke-width:1px;
    classDef async stroke-dasharray: 5 5,fill:#F9E79F,stroke:#333,stroke-width:1px;
    classDef cloud fill:#D7BDE2,stroke:#333,stroke-width:1px;
```
