# johnfrancis13/fam_mgmt architecture

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

- Interactive diagram: https://gitdiagram.com/johnfrancis13/fam_mgmt
- Repository: https://github.com/johnfrancis13/fam_mgmt

## Overview

##### Project type and purpose
- app.R at the root of src/ suggests a monolithic Shiny app that pulls together a set of feature modules (calendar, chores, meal planning, etc.) and a small data layer (SQLite DB + CSV).

##### File structure
- Top level:
- family_management_app.Rproj – RStudio project file.
- src/app.R – the single entry point that defines UI and server.
- src/modules/… – each feature has its own module script (calendar, chores, finances, fitness, home, meal planning, message board, shopping list).
- src/data/ – persistence: family_management.db (SQLite) and meal_lookup_table_editable.csv.
- src/utils.R – shared helper functions (e.g., DB connectors, common UI helpers).

##### Readme insights
- README.md only contains “# fam_mgmt,” no explicit architecture guidance.
- The structure implicitly uses Shiny modules as the architectural pattern for separation of concerns.

a. Main components
- Browser / Client: your end users (family members) interacting via web UI.
- Shiny Server Process (or local R session) hosting:
- UI Layer (defined in app.R)
- Server Logic Layer (app.R orchestrates modules + utils)
- Modules (8 distinct feature modules, each with UI and server functions)
- Data Layer:
- SQLite database (family_management.db)
- CSV file (meal_lookup_table_editable.csv)
b. Relationships & interactions
- Browser → HTTP/WebSocket → Shiny Server UI
- UI triggers module inputs → module server functions
- Module server functions call utils.R and/or DBI/RSQLite to read/write family_management.db or load CSV.
- utils.R provides shared logic (e.g., open DB connection, parameter validation).
- Data changes in DB persist across sessions and are reflected back through reactive endpoints to the UI.
c. Architectural patterns/design principles
- Shiny module pattern (UI + server pairs per feature) ensures separation of concerns and easier maintainability.
- Single‐page application model: all modules loaded within one Shiny app.
- Explicit data‐access layer (utils.R + RSQLite) decoupled from module logic.
d. Key technologies & libraries
- R, Shiny (UI/server framework)
- Shiny modules (modularization)
- DBI + RSQLite (SQLite access)
- Base R for CSV I/O (readr or utils::read.csv)

##### Essential architectural elements
- Don’t over‐split; the critical separation is UI vs. modules vs. data store.
- Shared utils.R as a common service layer.
- Clearly how data flows from the user interface down to the database and back.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Tier
    subgraph "Presentation Tier"
        Browser["Browser / Client"]:::presentation
        ShinyUI["Shiny App UI (app.R)"]:::presentation
    end

    %% Application Tier
    subgraph "Application Tier"
        direction TB
        Modules["Modules"]:::application
        Calendar["Module: Calendar"]:::application
        Chores["Module: Chores"]:::application
        Finances["Module: Finances"]:::application
        Fitness["Module: Fitness"]:::application
        Home["Module: Home"]:::application
        MealPlanning["Module: Meal Planning"]:::application
        MessageBoard["Module: Message Board"]:::application
        ShoppingList["Module: Shopping List"]:::application
        Utils["Shared Utilities (utils.R)"]:::application
    end

    %% Data Tier
    subgraph "Data Tier"
        DB["SQLite Database\n(family_management.db)"]:::data
        CSV["CSV Lookup Table\n(meal_lookup_table_editable.csv)"]:::data
    end

    %% Relationships
    Browser -->|"HTTP/WebSocket"| ShinyUI
    ShinyUI -->|loads/invokes| Calendar
    ShinyUI -->|loads/invokes| Chores
    ShinyUI -->|loads/invokes| Finances
    ShinyUI -->|loads/invokes| Fitness
    ShinyUI -->|loads/invokes| Home
    ShinyUI -->|loads/invokes| MealPlanning
    ShinyUI -->|loads/invokes| MessageBoard
    ShinyUI -->|loads/invokes| ShoppingList

    Calendar -->|calls| Utils
    Chores -->|calls| Utils
    Finances -->|calls| Utils
    Fitness -->|calls| Utils
    Home -->|calls| Utils
    MealPlanning -->|calls| Utils
    MessageBoard -->|calls| Utils
    ShoppingList -->|calls| Utils

    Utils -->|CRUD operations| DB
    Calendar -->|read/write| DB
    Chores -->|read/write| DB
    Finances -->|read/write| DB
    Fitness -->|read/write| DB
    Home -->|read/write| DB
    MessageBoard -->|read/write| DB
    ShoppingList -->|read/write| DB

    MealPlanning -->|load lookup data| CSV
    Utils -->|load lookup data| CSV

    %% Click Events
    click ShinyUI "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/app.R"
    click Calendar "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/modules/calendar_module.R"
    click Chores "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/modules/chores_module.R"
    click Finances "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/modules/finances_module.R"
    click Fitness "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/modules/fitness_module.R"
    click Home "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/modules/home_module.R"
    click MealPlanning "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/modules/meal_planning_module.R"
    click MessageBoard "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/modules/message_board_module.R"
    click ShoppingList "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/modules/shopping_list_module.R"
    click Utils "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/utils.R"
    click DB "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/data/family_management.db"
    click CSV "https://github.com/johnfrancis13/fam_mgmt/blob/main/src/data/meal_lookup_table_editable.csv"

    %% Styles
    classDef presentation fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef application fill:#90EE90,stroke:#333,stroke-width:1px
    classDef data fill:#FFA500,stroke:#333,stroke-width:1px
```
