# web3-builders-alliance/soda architecture

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

- Interactive diagram: https://gitdiagram.com/web3-builders-alliance/soda
- Repository: https://github.com/web3-builders-alliance/soda

## Overview

##### Project Type and Purpose
- Soda is both a CLI tool and a desktop app (via Tauri) backed by a Rust library (crate) and powered by a template repository.
- Purpose: read a Solana IDL, apply templates (Handlebars + Rhai), and emit client/program source code for web, mobile, or on-chain programs.

##### Top-Level Components from the File Structure
- assets: static visuals (logo)
- templates: multiple template sets (anchor, nextjs, react_native, seahorse, solana_flutter)
- crate: Rust library implementing the code-generation engine
- cli: Rust binary + JS glue for a terminal UI
- ui: Next.js/React frontend + Tauri (Rust) backend for the desktop GUI

##### Core Architecture and Flow
a. Input Sources
- Solana IDL file (idl.json)
- Template folder or packed template file (.soda)

b. Engines and Services
- Code-Generation Engine (crate):
- parse IDL
- load chosen template from `templates/…` via load_template.rs
- execute helpers (Rhai scripts) and render Handlebars templates
- assemble output file tree via write_project_to_fs.rs
- CLI Binary (`cli/src/main.rs`): invokes the crate’s public API (generate_project)
- Desktop App:
- Frontend (Next.js in `ui/`): user edits IDL, selects templates, previews
- Tauri Backend (`ui/src-tauri`): exposes Rust commands (generate, save, load) over IPC, calls into the same crate

c. Storage and I/O
- Local File System:
- Reads/writes IDL and template files
- Outputs generated project directories (programs, web client, mobile client)
- Optional: Download templates ZIP or fetch from GitHub

##### Relationships and Data Flow
- User (CLI or Desktop UI) → selects IDL & template
→ CLI/Tauri command → Code-Gen Engine (crate)
→ Engine loads IDL + template → renders code → writes to disk
- Template metadata (metadata.json) guides UI to display template options
- Helpers (Rhai scripts) injected by the engine at render time

##### Architectural Patterns and Principles
- Modular library (crate) shared by both CLI and Desktop App
- Plugin-style templates (file-based, language-agnostic)
- Clear separation of concerns:
- UI layer (React/Next.js)
- Backend commands (Tauri/Rust + CLI binary)
- Core engine (crate)
- Data store (file system)

##### Putting It All Together
- Layer 1 (User Layer): “Developer invokes CLI” and “Developer interacts with Desktop App.”
- Layer 4 (Storage Layer): “Templates” and “File System (IDL + Generated Code).”

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Layer
    Actor([Developer]):::actor

    %% Application Layer
    subgraph "Application Layer"
        subgraph "CLI Binary" 
            CLI_main["main.rs"]:::backend
            CLI_pre["pre-install.js"]:::backend
            CLI_start["start.js"]:::backend
            CLI_uninstall["uninstall.js"]:::backend
            CLI_pkg["package.json"]:::backend
        end
        subgraph "Desktop App"
            subgraph "Frontend (Next.js/React)" 
                UI_pages["ui/pages/"]:::frontend
                UI_comp["ui/components/"]:::frontend
                UI_ctx["ui/context/"]:::frontend
                UI_helpers_ui["ui/helpers/"]:::frontend
                UI_public["ui/public/"]:::frontend
                UI_styles["styles/globals.css"]:::frontend
                UI_nextcfg["next.config.js"]:::frontend
                UI_pkg2["package.json"]:::frontend
            end
            subgraph "Backend (Tauri/Rust)"
                TAU_Cargo["Cargo.toml"]:::backend
                TAU_main["main.rs"]:::backend
                TAU_gen["generate.rs"]:::backend
                TAU_gen_idl["generate_idl_file.rs"]:::backend
                TAU_gen_tmpl["generate_template_file.rs"]:::backend
                TAU_update_idl["update_idl_string.rs"]:::backend
                TAU_update_tmpl["update_template.rs"]:::backend
                TAU_update_base["update_base_folder_path.rs"]:::backend
                TAU_newwin["new_window.rs"]:::backend
                TAU_default["default_template.rs"]:::backend
                TAU_err["error.rs"]:::backend
            end
        end
    end

    %% Engine Layer
    subgraph "Code-Gen Engine (crate)"
        CE_lib["lib.rs"]:::core
        CE_gen_idl["generate_from_idl.rs"]:::core
        CE_get_tmpl["get_template_from_fs.rs"]:::core
        CE_load_tmpl["load_template.rs"]:::core
        CE_helpers["helpers.rs"]:::core
        CE_write_fs["write_project_to_fs.rs"]:::core
        CE_gen_proj["generate_project.rs"]:::core
        CE_save_tmpl["save_template.rs"]:::core
        CE_structs["structs.rs"]:::core
    end

    %% Templates Layer
    subgraph "Templates Repository"
        T_anchor["anchor/"]:::storage
        T_nextjs["nextjs/"]:::storage
        T_rnative["react_native/"]:::storage
        T_seahorse["seahorse/"]:::storage
        T_sflutter["solana_flutter/"]:::storage
    end

    %% Storage Layer
    subgraph "File System"
        FS_idl["IDL (idl.json)"]:::storage
        FS_output["Generated Code Output"]:::storage
    end

    %% Relations
    Actor -->|"invoke"| CLI_main
    Actor -->|"open"| UI_pages
    CLI_main -->|"calls generate_project()"| CE_gen_proj
    TAU_main -->|"IPC generate"| CE_gen_proj
    UI_pages -->|"user selects IDL/template"| TAU_main
    CE_gen_proj -->|"load IDL"| FS_idl
    CE_gen_proj -->|"load templates"| CE_load_tmpl
    CE_load_tmpl -->|"read files"| T_anchor
    CE_load_tmpl -->|"read files"| T_nextjs
    CE_load_tmpl -->|"read files"| T_rnative
    CE_load_tmpl -->|"read files"| T_seahorse
    CE_load_tmpl -->|"read files"| T_sflutter
    CE_gen_proj -->|"render helpers"| CE_helpers
    CE_gen_proj -->|"render templates"| CE_lib
    CE_gen_proj -->|"write output"| CE_write_fs
    CE_write_fs -->|"write to"| FS_output

    %% Click Events - CLI
    click CLI_main "https://github.com/web3-builders-alliance/soda/blob/main/cli/src/main.rs"
    click CLI_pre "https://github.com/web3-builders-alliance/soda/blob/main/cli/pre-install.js"
    click CLI_start "https://github.com/web3-builders-alliance/soda/blob/main/cli/start.js"
    click CLI_uninstall "https://github.com/web3-builders-alliance/soda/blob/main/cli/uninstall.js"
    click CLI_pkg "https://github.com/web3-builders-alliance/soda/blob/main/cli/package.json"

    %% Click Events - Frontend
    click UI_pages "https://github.com/web3-builders-alliance/soda/tree/main/ui/pages/"
    click UI_comp "https://github.com/web3-builders-alliance/soda/tree/main/ui/components/"
    click UI_ctx "https://github.com/web3-builders-alliance/soda/tree/main/ui/context/"
    click UI_helpers_ui "https://github.com/web3-builders-alliance/soda/tree/main/ui/helpers/"
    click UI_public "https://github.com/web3-builders-alliance/soda/tree/main/ui/public/"
    click UI_styles "https://github.com/web3-builders-alliance/soda/blob/main/ui/styles/globals.css"
    click UI_nextcfg "https://github.com/web3-builders-alliance/soda/blob/main/ui/next.config.js"
    click UI_pkg2 "https://github.com/web3-builders-alliance/soda/blob/main/ui/package.json"

    %% Click Events - Backend (Tauri)
    click TAU_Cargo "https://github.com/web3-builders-alliance/soda/blob/main/ui/src-tauri/Cargo.toml"
    click TAU_main "https://github.com/web3-builders-alliance/soda/blob/main/ui/src-tauri/src/main.rs"
    click TAU_gen "https://github.com/web3-builders-alliance/soda/blob/main/ui/src-tauri/src/generate.rs"
    click TAU_gen_idl "https://github.com/web3-builders-alliance/soda/blob/main/ui/src-tauri/src/generate_idl_file.rs"
    click TAU_gen_tmpl "https://github.com/web3-builders-alliance/soda/blob/main/ui/src-tauri/src/generate_template_file.rs"
    click TAU_update_idl "https://github.com/web3-builders-alliance/soda/blob/main/ui/src-tauri/src/update_idl_string.rs"
    click TAU_update_tmpl "https://github.com/web3-builders-alliance/soda/blob/main/ui/src-tauri/src/update_template.rs"
    click TAU_update_base "https://github.com/web3-builders-alliance/soda/blob/main/ui/src-tauri/src/update_base_folder_path.rs"
    click TAU_newwin "https://github.com/web3-builders-alliance/soda/blob/main/ui/src-tauri/src/new_window.rs"
    click TAU_default "https://github.com/web3-builders-alliance/soda/blob/main/ui/src-tauri/src/default_template.rs"
    click TAU_err "https://github.com/web3-builders-alliance/soda/blob/main/ui/src-tauri/src/error.rs"

    %% Click Events - Engine (crate)
    click CE_lib "https://github.com/web3-builders-alliance/soda/blob/main/crate/src/lib.rs"
    click CE_gen_idl "https://github.com/web3-builders-alliance/soda/blob/main/crate/src/generate_from_idl.rs"
    click CE_get_tmpl "https://github.com/web3-builders-alliance/soda/blob/main/crate/src/get_template_from_fs.rs"
    click CE_load_tmpl "https://github.com/web3-builders-alliance/soda/blob/main/crate/src/load_template.rs"
    click CE_helpers "https://github.com/web3-builders-alliance/soda/blob/main/crate/src/helpers.rs"
    click CE_write_fs "https://github.com/web3-builders-alliance/soda/blob/main/crate/src/write_project_to_fs.rs"
    click CE_gen_proj "https://github.com/web3-builders-alliance/soda/blob/main/crate/src/generate_project.rs"
    click CE_save_tmpl "https://github.com/web3-builders-alliance/soda/blob/main/crate/src/save_template.rs"
    click CE_structs "https://github.com/web3-builders-alliance/soda/blob/main/crate/src/structs.rs"

    %% Click Events - Templates
    click T_anchor "https://github.com/web3-builders-alliance/soda/tree/main/templates/anchor/"
    click T_nextjs "https://github.com/web3-builders-alliance/soda/tree/main/templates/nextjs/"
    click T_rnative "https://github.com/web3-builders-alliance/soda/tree/main/templates/react_native/"
    click T_seahorse "https://github.com/web3-builders-alliance/soda/tree/main/templates/seahorse/"
    click T_sflutter "https://github.com/web3-builders-alliance/soda/tree/main/templates/solana_flutter/"

    %% Styles
    classDef actor fill:#f9f,stroke:#333,stroke-width:2px;
    classDef frontend fill:#ccf,stroke:#333,stroke-width:1px;
    classDef backend fill:#cfc,stroke:#333,stroke-width:1px;
    classDef core fill:#fc9,stroke:#333,stroke-width:1px;
    classDef storage fill:#eee,stroke:#666,stroke-width:1px;
```
