# plainionist/mind-elixir-shell architecture

> Architecture diagram of the GitHub repository plainionist/mind-elixir-shell, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-03-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/plainionist/mind-elixir-shell
- Repository: https://github.com/plainionist/mind-elixir-shell

## Overview

##### Project type & purpose (what you’re diagramming)
This is a **Tauri desktop application** that embeds a **web UI (Vue + Vite)** and hosts the **Mind Elixir** mind-map editor inside a native shell. The “backend” is not a web server; it’s **Tauri’s Rust runtime** providing OS integration (windowing, filesystem, app lifecycle, etc.) via the Tauri IPC bridge.

Key indicators:
- `src-tauri/` ⇒ Tauri Rust side (native host, commands, capabilities, bundling)
- `src/` with `App.vue`, `main.ts`, `vite.config.ts` ⇒ SPA frontend bundled into static assets
- README explicitly: “Uses Tauri to host ‘Mind Elixir’ in a desktop app.” and links to `mind-elixir-core` (external upstream dependency)

- **Desktop app container** (Tauri)
- **Web UI runtime** (Vue + Mind Elixir running in a WebView)
- **Native integration boundary** (Tauri JS API ↔ Rust commands)
- **OS resources** (filesystem, window controls, app lifecycle)
- **External dependency** (`mind-elixir-core`) as a library integrated into the frontend

##### Frontend (WebView content)
- `src/main.ts` → bootstraps Vue app
- `src/App.vue` → root UI composition (likely hosts the Mind Elixir canvas + chrome)
- `src/components/DescriptionBox.vue` → a UI sub-component for descriptions/metadata
- `src/composables/*`
- `useFileOperations.ts` → strongly suggests open/save/import/export flows (probably calling Tauri filesystem/dialog APIs)
- `useSaveOnClose.ts` → app lifecycle integration (close event triggers save / prompt)
- `useFullscreen.ts` → window/fullscreen control via Tauri window APIs
- `useDescription.ts` → manages description state, likely tied to mindmap nodes
- `src/themes.ts` → theming layer (optional detail unless you’re diagramming UI internals)

##### Native host (Tauri / Rust)
- `src-tauri/src/main.rs` → Tauri entrypoint (builds the app, registers commands/plugins)
- `src-tauri/src/lib.rs` → often where Tauri commands, helpers, and modules live
- `src-tauri/tauri.conf.json` → app metadata, bundling, window config, permissions hooks
- `src-tauri/capabilities/default.json` → security permissions/capabilities (important boundary!)
- `src-tauri/build.rs` → build-time tasks (bundling resources, config)

##### Build & tooling
- `vite.config.ts`, `package.json`, `pnpm-lock.yaml` → frontend build pipeline
- `Cargo.toml`, `Cargo.lock` → Rust dependencies and build
- `index.html`, `public/` → static entry

- User
- Tauri Desktop App
- WebView (Vue + Mind Elixir)
- Rust Core (Tauri runtime + your commands)
- OS services (Filesystem, Window Manager)
- External libraries (Mind Elixir Core)

- Vue Root (`App.vue`)
- Composables modules (file ops, fullscreen, save-on-close, description)
- Mind Elixir editor component/library (imported dependency)
- Tauri JS APIs / IPC boundary
- Rust command handlers / services (in `lib.rs` / `main.rs`)

- “Open file” flow
- “Save” / “Save on close” flow
- “Toggle fullscreen” flow
These make the IPC boundary + OS access explicit and unambiguous.

Directly in component labels:
- **Tauri (Rust)**
- **Vue 3 + TypeScript**
- **Mind Elixir Core** (external dependency; show as “3rd-party library” inside WebView)
- **OS services**: filesystem, window manager

##### Concrete diagramming guidance (how to make it “best and most accurate”)

- “Edit mindmap (in-memory state)”
- “Invoke save (Tauri IPC)”
- “Write file (OS filesystem)”
- “Toggle fullscreen (window API)”
- “Close event → save prompt (lifecycle hook)”

##### Don’t collapse too early—separate into as many components as possible
For this repo, a good “detailed but still readable” component breakdown is:
- `App.vue`
- `DescriptionBox.vue`
- `useDescription`
- `useFileOperations`
- `useFullscreen`
- `useSaveOnClose`
- “Mind Elixir Core (editor engine)”
- “Tauri JS API / invoke layer”
- “Rust commands (lib.rs)”
- “Tauri runtime bootstrap (main.rs)”
- “Capabilities (default.json)”
- “Filesystem (local documents)”
- “Window manager (fullscreen, close)”

## Diagram (Mermaid)

```mermaid
flowchart TD
  %% =========================
  %% Global actors & externals
  %% =========================
  U["User"]:::external
  ME["mind-elixir-core (3rd-party library)"]:::thirdparty

  subgraph "Desktop OS"
    direction TB
    OSFS[("Local filesystem\n(mindmap documents: .json etc.)")]:::datastore
    OSWM["Window manager / Display"]:::os
  end

  %% =========================
  %% Tauri Desktop App Process
  %% =========================
  subgraph "Tauri Desktop App Process"
    direction TB

    %% ---- WebView (Frontend) ----
    subgraph "WebView Runtime (Frontend)"
      direction TB

      HTML["index.html (WebView shell)"]:::frontend
      FE["Vue 3 + TypeScript App (src/)"]:::frontend
      MAIN["main.ts (bootstrap + mount)"]:::frontend
      APP["App.vue (root composition)"]:::frontend

      subgraph "UI Components"
        direction TB
        DESCBOX["DescriptionBox.vue"]:::frontend
      end

      subgraph "Vue Composables (service modules)"
        direction TB
        USEDESC["useDescription.ts"]:::frontend
        FILEOPS["useFileOperations.ts"]:::frontend
        FULLSCR["useFullscreen.ts"]:::frontend
        SAVEONCLOSE["useSaveOnClose.ts"]:::frontend
      end

      SEED["sample-data.ts (seed mindmap data)"]:::data
      THEMES["themes.ts (theming)"]:::frontend

      EDITOR["Mind map editor runtime\n(Mind Elixir integrated)"]:::thirdparty

      TAURIJS["Tauri JS API / invoke layer"]:::bridge
    end

    %% ---- IPC Boundary ----
    IPC["Tauri IPC Bridge\n(JS API ↔ Rust commands)"]:::bridge

    %% ---- Rust Runtime (Native) ----
    subgraph "Rust Runtime (Tauri Core)"
      direction TB
      RMAIN["main.rs (app bootstrap)"]:::native
      RLIB["lib.rs (commands + helpers)"]:::native
      CAP["Capabilities allowlist\n(default.json)"]:::security
      CONF["tauri.conf.json\n(app/window/bundle metadata)"]:::native
    end
  end

  %% =========================
  %% Build & Packaging (Optional)
  %% =========================
  subgraph "Build & Packaging"
    direction TB
    VITE["vite.config.ts (Vite build pipeline)"]:::build
    PKG["package.json (frontend deps)"]:::build
    CARGO["Cargo.toml (Rust deps)"]:::build
    BUILD_RS["src-tauri/build.rs (build tasks)"]:::build
    ICONS["icons/* (distribution assets)"]:::build
  end

  %% =========================
  %% Runtime relationships
  %% =========================
  U -->|"EditMindmap(UI)"| APP
  MAIN -->|"MountApp()"| APP
  HTML -->|"LoadAssets()"| MAIN

  APP -->|"ComposeUI()"| DESCBOX
  APP -->|"UseComposables()"| USEDESC
  APP -->|"UseComposables()"| FILEOPS
  APP -->|"UseComposables()"| FULLSCR
  APP -->|"UseComposables()"| SAVEONCLOSE

  SEED -->|"InitialState()"| EDITOR
  USEDESC -->|"BindDescriptionState()"| DESCBOX
  APP -->|"RenderEditor()"| EDITOR
  ME -->|"LibraryImport()"| EDITOR

  FILEOPS -->|"InvokeOpen/Save()"| TAURIJS
  FULLSCR -->|"InvokeFullscreen()"| TAURIJS
  SAVEONCLOSE -->|"CloseEvent→Prompt/Save()"| TAURIJS

  TAURIJS -->|"IPCInvoke()"| IPC
  IPC -->|"DispatchCommand()"| RLIB

  RMAIN -->|"RegisterCommands()"| RLIB
  CAP -->|"EnforcePermissions()"| RLIB

  RLIB -->|"Read/WriteDocument()"| OSFS
  RLIB -->|"WindowControl()"| OSWM

  %% =========================
  %% Build/packaging relationships
  %% =========================
  PKG -->|"DefinesFrontendDeps()"| VITE
  VITE -->|"BundlesSPAAssets()"| HTML
  CARGO -->|"DefinesRustDeps()"| RMAIN
  BUILD_RS -->|"BuildTimeSteps()"| RMAIN
  CONF -->|"BundleConfig()"| BUILD_RS
  ICONS -->|"PackagedIntoInstaller()"| BUILD_RS

  %% =========================
  %% Click events (from mapping)
  %% =========================
  click FE "https://github.com/plainionist/mind-elixir-shell/tree/main/src/"
  click MAIN "https://github.com/plainionist/mind-elixir-shell/blob/main/src/main.ts"
  click APP "https://github.com/plainionist/mind-elixir-shell/blob/main/src/App.vue"
  click DESCBOX "https://github.com/plainionist/mind-elixir-shell/blob/main/src/components/DescriptionBox.vue"
  click USEDESC "https://github.com/plainionist/mind-elixir-shell/blob/main/src/composables/useDescription.ts"
  click FILEOPS "https://github.com/plainionist/mind-elixir-shell/blob/main/src/composables/useFileOperations.ts"
  click FULLSCR "https://github.com/plainionist/mind-elixir-shell/blob/main/src/composables/useFullscreen.ts"
  click SAVEONCLOSE "https://github.com/plainionist/mind-elixir-shell/blob/main/src/composables/useSaveOnClose.ts"
  click SEED "https://github.com/plainionist/mind-elixir-shell/blob/main/src/sample-data.ts"
  click THEMES "https://github.com/plainionist/mind-elixir-shell/blob/main/src/themes.ts"
  click HTML "https://github.com/plainionist/mind-elixir-shell/blob/main/index.html"
  click VITE "https://github.com/plainionist/mind-elixir-shell/blob/main/vite.config.ts"
  click PKG "https://github.com/plainionist/mind-elixir-shell/blob/main/package.json"

  click RMAIN "https://github.com/plainionist/mind-elixir-shell/blob/main/src-tauri/src/main.rs"
  click RLIB "https://github.com/plainionist/mind-elixir-shell/blob/main/src-tauri/src/lib.rs"
  click CAP "https://github.com/plainionist/mind-elixir-shell/blob/main/src-tauri/capabilities/default.json"
  click CONF "https://github.com/plainionist/mind-elixir-shell/blob/main/src-tauri/tauri.conf.json"
  click BUILD_RS "https://github.com/plainionist/mind-elixir-shell/blob/main/src-tauri/build.rs"
  click CARGO "https://github.com/plainionist/mind-elixir-shell/blob/main/src-tauri/Cargo.toml"
  click ICONS "https://github.com/plainionist/mind-elixir-shell/tree/main/src-tauri/icons/"
  
  %% root host directory mapping
  click IPC "https://github.com/plainionist/mind-elixir-shell/tree/main/src-tauri/"
  
  %% =========================
  %% Styles
  %% =========================
  classDef external fill:#f5f5f5,stroke:#6b7280,stroke-width:1px,color:#111827
  classDef os fill:#e5e7eb,stroke:#4b5563,stroke-width:1px,color:#111827
  classDef datastore fill:#d1d5db,stroke:#374151,stroke-width:1.5px,color:#111827
  classDef frontend fill:#dbeafe,stroke:#2563eb,stroke-width:1.2px,color:#0f172a
  classDef native fill:#dcfce7,stroke:#16a34a,stroke-width:1.2px,color:#052e16
  classDef bridge fill:#cffafe,stroke:#0891b2,stroke-width:2px,color:#083344
  classDef security fill:#fee2e2,stroke:#dc2626,stroke-width:2px,color:#450a0a
  classDef thirdparty fill:#ffedd5,stroke:#f97316,stroke-width:1.2px,color:#431407
  classDef build fill:#ede9fe,stroke:#7c3aed,stroke-width:1.1px,color:#2e1065
  classDef data fill:#e0f2fe,stroke:#0284c7,stroke-width:1.1px,color:#0c4a6e
```
