# nuttikung/share-meal architecture

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

- Interactive diagram: https://gitdiagram.com/nuttikung/share-meal
- Repository: https://github.com/nuttikung/share-meal

## Overview

##### Project type and purpose
- This is a single-page/front-end application built in Rust using the Dioxus framework.
- It uses Tailwind CSS for styling and a small Node toolchain for CSS compilation.
- The `dx serve` command (from Dioxus CLI) launches a development server targeting web, iOS, or desktop.

##### File structure
- Top-level files:
- Cargo.toml / Dioxus.toml – Rust project and Dioxus configuration
- package.json / tailwind.config.js – Tailwind CSS and NPM metadata
- Dockerfile / .dockerignore – containerization for production or CI
- `src/` directory:
- `main.rs` – application entrypoint (initializes Dioxus app)
- `lib.rs` – shared library code
- `components/` – UI components, grouped by feature (member, order, stats, tab)
- `state/` – centralized application state modules (app_state, member, order)
- `helper/` – utility functions (e.g., price formatting)
- `assets/` directory: compiled CSS and other static files.

##### README for additional insights
- Confirms use of `dx serve` as the development server.
- Describes Tailwind installation and watch commands.
- No backend or database: purely client-side (WASM or native via Dioxus).

##### Main components and their relationships
a. Development & Build Tools
- Dioxus CLI (`dx serve`)
- Node/Tailwind CLI (`npx tailwindcss`)
- Docker build (optional production image)
b. Runtime environment
- Dioxus runtime (web renderer or native host)
- Application modules:
– UI Layer: `src/components/*`
– State Layer: `src/state/*`
– Helpers: `src/helper/*`
– Assets: compiled CSS in `assets/`
c. Data flow & interactions
- User interacts with UI components → Components dispatch actions or callbacks → State modules update data → Dioxus re-renders affected components
- Helper modules provide pure functions (e.g., price formatting) to components or state
- Tailwind CLI watches `input.css` → emits `assets/tailwind.css` → loaded by the application

##### Architectural patterns and design principles
- Component-based UI (small, reusable Rust components)
- Unidirectional data flow (Flux-style state management)
- Clear separation of concerns:
- Presentation (components)
- State & business logic (state modules)
- Utility logic (helper modules)
- Styling (Tailwind)

##### Detailed breakdown for diagramming
- Dioxus CLI (dx serve) → Rust compiler → WASM/Binary
- Tailwind CLI (`input.css` → `assets/tailwind.css`)
- Dockerfile (optional)
- Dioxus Runtime (Browser / Native Host) at top
- Under it, three columns:
- UI Components
– TabViewSwitcher, MemberList, OrderList, StatsOverview, etc.
- State Modules
– AppState, MemberState, OrderState
- Helper Modules
– Price formatting, common utilities
- Assets (tailwind.css, main.css) sits alongside UI and is loaded at startup
- Components → read/write to State modules
- Components → call Helper functions
- Dioxus Runtime → mounts UI components and injects CSS assets
- User events → UI Components → State updates → Re-render cycle

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Build & Dev Tools
    subgraph "Build & Dev Tools"
        direction TB
        CargoToml["Cargo.toml"]:::build
        DioxusToml["Dioxus.toml"]:::build
        TailwindConfig["tailwind.config.js"]:::build
        InputCSS["input.css"]:::build
        TailwindCLI["Tailwind CLI"]:::build
        RustCompiler["Rust Compiler"]:::build
        DioxusCLI["Dioxus CLI (dx serve)"]:::build
        Dockerfile["Dockerfile"]:::build
        DockerIgnore[".dockerignore"]:::build
        ProductionImage["Production Image"]:::build

        InputCSS -->|reads| TailwindCLI
        TailwindConfig -->|configures| TailwindCLI
        TailwindCLI -->|outputs| AssetsMain["assets/main.css"]:::asset
        TailwindCLI -->|outputs| AssetsTailwind["assets/tailwind.css"]:::asset

        DioxusCLI -->|invokes| RustCompiler
        RustCompiler -->|compiles| WASMBin["WASM/Binary"]:::build

        Dockerfile -->|builds| ProductionImage
        DockerIgnore -->|excludes| ProductionImage
    end

    %% Runtime
    subgraph "Runtime"
        direction TB
        DioxusRuntime["Dioxus Runtime (Browser/Native)"]:::build

        subgraph "UI Components"
            direction TB
            TabViewSwitcher["TabViewSwitcher"]:::ui
            MemberList["MemberList"]:::ui
            MemberInput["MemberInput"]:::ui
            MemberClearBtn["MemberClearButton"]:::ui
            MemberRecord["MemberRecord"]:::ui
            MemberHelper["member/helper.rs"]:::ui
            MemberMod["member/mod.rs"]:::ui
            OrderList["OrderList"]:::ui
            OrderInput["OrderInput"]:::ui
            OrderInsert["OrderInsert"]:::ui
            OrderCheckbox["OrderMemberCheckBox"]:::ui
            OrderModal["OrderModalEdit"]:::ui
            OrderPriceInput["OrderPriceInput"]:::ui
            OrderRecord["OrderRecord"]:::ui
            OrderMod["order/mod.rs"]:::ui
            StatsOverview["StatsOverview"]:::ui
            StatsMod["stats/mod.rs"]:::ui
            ComponentsIndex["components/mod.rs"]:::ui
        end

        subgraph "State Modules"
            direction TB
            AppState["app_state.rs"]:::state
            MemberState["member.rs"]:::state
            OrderState["order.rs"]:::state
            StateIndex["state/mod.rs"]:::state
        end

        subgraph "Helper Modules"
            direction TB
            PriceUtil["price.rs"]:::helper
            HelperMod["helper/mod.rs"]:::helper
        end

        subgraph "Assets"
            direction TB
            AssetsMain
            AssetsTailwind
        end

        User["User"]:::build

        User -->|interacts| TabViewSwitcher
        User -->|interacts| MemberList
        User -->|interacts| OrderList

        TabViewSwitcher -->|"dispatches"| AppState
        MemberList -->|"dispatches"| MemberState
        OrderList -->|"dispatches"| OrderState

        TabViewSwitcher -->|"uses"| PriceUtil
        MemberList -->|"uses"| PriceUtil
        OrderList -->|"uses"| PriceUtil

        DioxusRuntime -->|mounts| TabViewSwitcher
        DioxusRuntime -->|loads CSS| AssetsMain
        DioxusRuntime -->|loads CSS| AssetsTailwind
    end

    %% Click Events
    click CargoToml "https://github.com/nuttikung/share-meal/blob/main/Cargo.toml"
    click DioxusToml "https://github.com/nuttikung/share-meal/blob/main/Dioxus.toml"
    click TailwindConfig "https://github.com/nuttikung/share-meal/blob/main/tailwind.config.js"
    click InputCSS "https://github.com/nuttikung/share-meal/blob/main/input.css"
    click AssetsMain "https://github.com/nuttikung/share-meal/blob/main/assets/main.css"
    click AssetsTailwind "https://github.com/nuttikung/share-meal/blob/main/assets/tailwind.css"
    click Dockerfile "https://github.com/nuttikung/share-meal/tree/main/Dockerfile"
    click DockerIgnore "https://github.com/nuttikung/share-meal/blob/main/.dockerignore"
    click DioxusCLI "https://github.com/nuttikung/share-meal/blob/main/src/main.rs"
    click RustCompiler "https://github.com/nuttikung/share-meal/blob/main/src/lib.rs"
    click TabViewSwitcher "https://github.com/nuttikung/share-meal/blob/main/src/components/tab/tab_view_switcher.rs"
    click MemberList "https://github.com/nuttikung/share-meal/blob/main/src/components/member/member_list.rs"
    click MemberInput "https://github.com/nuttikung/share-meal/blob/main/src/components/member/member_input.rs"
    click MemberClearBtn "https://github.com/nuttikung/share-meal/blob/main/src/components/member/member_clear_button.rs"
    click MemberRecord "https://github.com/nuttikung/share-meal/blob/main/src/components/member/member_record.rs"
    click MemberHelper "https://github.com/nuttikung/share-meal/blob/main/src/components/member/helper.rs"
    click MemberMod "https://github.com/nuttikung/share-meal/blob/main/src/components/member/mod.rs"
    click OrderList "https://github.com/nuttikung/share-meal/blob/main/src/components/order/order_list.rs"
    click OrderInput "https://github.com/nuttikung/share-meal/blob/main/src/components/order/order_input.rs"
    click OrderInsert "https://github.com/nuttikung/share-meal/blob/main/src/components/order/order_insert.rs"
    click OrderCheckbox "https://github.com/nuttikung/share-meal/blob/main/src/components/order/order_member_check_box.rs"
    click OrderModal "https://github.com/nuttikung/share-meal/blob/main/src/components/order/order_modal_edit.rs"
    click OrderPriceInput "https://github.com/nuttikung/share-meal/blob/main/src/components/order/order_price_input.rs"
    click OrderRecord "https://github.com/nuttikung/share-meal/blob/main/src/components/order/order_record.rs"
    click OrderMod "https://github.com/nuttikung/share-meal/blob/main/src/components/order/mod.rs"
    click StatsOverview "https://github.com/nuttikung/share-meal/blob/main/src/components/stats/stats_overview.rs"
    click StatsMod "https://github.com/nuttikung/share-meal/blob/main/src/components/stats/mod.rs"
    click ComponentsIndex "https://github.com/nuttikung/share-meal/blob/main/src/components/mod.rs"
    click AppState "https://github.com/nuttikung/share-meal/blob/main/src/state/app_state.rs"
    click MemberState "https://github.com/nuttikung/share-meal/blob/main/src/state/member.rs"
    click OrderState "https://github.com/nuttikung/share-meal/blob/main/src/state/order.rs"
    click StateIndex "https://github.com/nuttikung/share-meal/blob/main/src/state/mod.rs"
    click PriceUtil "https://github.com/nuttikung/share-meal/blob/main/src/helper/price.rs"
    click HelperMod "https://github.com/nuttikung/share-meal/blob/main/src/helper/mod.rs"

    %% Styles
    classDef ui fill:#cce5ff,stroke:#004085,color:#004085
    classDef state fill:#d4edda,stroke:#155724,color:#155724
    classDef helper fill:#fff3cd,stroke:#856404,color:#856404
    classDef build fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef asset fill:#ffe5b4,stroke:#d2691e,color:#d2691e
```
