# mellofordev/electro-start architecture

> Architecture diagram of the GitHub repository mellofordev/electro-start, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mellofordev/electro-start
- Repository: https://github.com/mellofordev/electro-start

## Overview

electro-start lets a React webview call functions executed in the app’s Bun main process. The principal path is: Vite transforms action imports into client stubs; the client serializes a call, the Bun runtime dispatches it to a registered implementation, and the result or structured error is serialized back. The repository also provides a project-scaffolding CLI and a query entry point. Runtime relationships are grounded in excerpts and the source index; the README documents the higher-level Vite-to-RPC workflow.

Main entry points: [`packages/electro-start/src/index.ts`](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/index.ts) (Main functions), [`packages/electro-start/src/client/stub.ts`](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/client/stub.ts) (Client stubs), [`packages/create-electro-start/src/index.ts`](https://github.com/mellofordev/electro-start/blob/master/packages/create-electro-start/src/index.ts) (Scaffold CLI), [`packages/electro-start/src/runtime/index.ts`](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/runtime/index.ts) (Runtime startup)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["Project scaffolding"]
  node_cli_entry["Scaffold CLI<br/>[index.ts]"]
  node_cli_args["Argument parsing<br/>[args.ts]"]
  node_cli_prompts["Setup prompts<br/>[prompts.ts]"]
  node_cli_scaffold["Template scaffolding<br/>[scaffold.ts]"]
  node_cli_install["Dependency install<br/>[install.ts]"]
end

subgraph group_authoring["Action authoring"]
  node_actions["Main functions<br/>[index.ts]"]
  node_id["Function IDs<br/>[id.ts]"]
  node_serialization["Wire serialization<br/>[serialize.ts]"]
  node_query["Query API<br/>[index.ts]"]
end

subgraph group_webview["Webview client"]
  node_vite["Vite transform<br/>[index.ts]"]
  node_client_stub["Client stubs<br/>[stub.ts]"]
  node_client_errors["Client errors<br/>[errors.ts]"]
  node_client_init["Client initialization<br/>[index.ts]"]
end

subgraph group_bun["Bun runtime"]
  node_bun_plugin["Bun plugin<br/>[bun-plugin.ts]"]
  node_discovery["Function discovery<br/>[discovery.ts]"]
  node_runtime["Runtime startup<br/>[index.ts]"]
  node_registry[("Function registry<br/>[registry.ts]")]
  node_rpc["RPC bridge<br/>[rpc.ts]"]
  node_handler["Call handler<br/>[handler.ts]"]
end

node_developer(("App developer"))
node_webview_actor(("React webview"))
node_electrobun["Electrobun bridge"]

node_developer -->|"runs"| node_cli_entry
node_cli_entry -->|"parses arguments"| node_cli_args
node_cli_entry -->|"resolves options"| node_cli_prompts
node_cli_entry -->|"scaffolds project"| node_cli_scaffold
node_cli_entry -->|"installs dependencies"| node_cli_install
node_cli_prompts -->|"uses parsed options"| node_cli_args
node_developer -->|"defines functions"| node_actions
node_actions -->|"registers handlers"| node_registry
node_actions -->|"creates client stubs"| node_client_stub
node_actions -->|"exports ID helper"| node_id
node_actions -->|"exports wire types"| node_serialization
node_actions -->|"uses with transform"| node_vite
node_vite -->|"generates webview stubs"| node_webview_actor
node_webview_actor -->|"invokes function"| node_client_stub
node_client_stub -->|"encodes call"| node_serialization
node_client_stub -->|"raises remote errors"| node_client_errors
node_client_init -->|"installs dispatcher"| node_client_stub
node_client_stub -->|"dispatches RPC"| node_electrobun
node_electrobun -->|"forwards call"| node_rpc
node_bun_plugin -->|"starts discovery"| node_discovery
node_runtime -->|"discovers functions"| node_discovery
node_runtime -->|"wires RPC"| node_rpc
node_runtime -->|"uses registry"| node_registry
node_discovery -->|"derives IDs"| node_id
node_rpc -->|"routes calls"| node_handler
node_handler -->|"looks up handler"| node_registry
node_handler -->|"decodes and encodes"| node_serialization
node_query -->|"builds on API"| node_actions

click node_cli_entry "https://github.com/mellofordev/electro-start/blob/master/packages/create-electro-start/src/index.ts"
click node_cli_args "https://github.com/mellofordev/electro-start/blob/master/packages/create-electro-start/src/args.ts"
click node_cli_prompts "https://github.com/mellofordev/electro-start/blob/master/packages/create-electro-start/src/prompts.ts"
click node_cli_scaffold "https://github.com/mellofordev/electro-start/blob/master/packages/create-electro-start/src/scaffold.ts"
click node_cli_install "https://github.com/mellofordev/electro-start/blob/master/packages/create-electro-start/src/install.ts"
click node_actions "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/index.ts"
click node_id "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/id.ts"
click node_vite "https://github.com/mellofordev/electro-start/blob/master/packages/vite-plugin/src/index.ts"
click node_client_stub "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/client/stub.ts"
click node_client_errors "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/client/errors.ts"
click node_serialization "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/serialize.ts"
click node_client_init "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/client/index.ts"
click node_bun_plugin "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/bun-plugin.ts"
click node_discovery "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/runtime/discovery.ts"
click node_runtime "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/runtime/index.ts"
click node_registry "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/runtime/registry.ts"
click node_rpc "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/runtime/rpc.ts"
click node_handler "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/runtime/handler.ts"
click node_query "https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/query/index.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli_entry,node_cli_args,node_cli_prompts,node_cli_scaffold,node_cli_install,node_webview_actor toneBlue
class node_actions,node_id,node_serialization,node_query toneAmber
class node_vite,node_client_stub,node_client_errors,node_client_init toneMint
class node_bun_plugin,node_discovery,node_runtime,node_registry,node_rpc,node_handler toneRose
class node_developer,node_electrobun toneIndigo
```

## Components

### Project scaffolding

- [Scaffold CLI](https://github.com/mellofordev/electro-start/blob/master/packages/create-electro-start/src/index.ts): `packages/create-electro-start/src/index.ts`
- [Argument parsing](https://github.com/mellofordev/electro-start/blob/master/packages/create-electro-start/src/args.ts): `packages/create-electro-start/src/args.ts`
- [Setup prompts](https://github.com/mellofordev/electro-start/blob/master/packages/create-electro-start/src/prompts.ts): `packages/create-electro-start/src/prompts.ts`
- [Template scaffolding](https://github.com/mellofordev/electro-start/blob/master/packages/create-electro-start/src/scaffold.ts): `packages/create-electro-start/src/scaffold.ts`
- [Dependency install](https://github.com/mellofordev/electro-start/blob/master/packages/create-electro-start/src/install.ts): `packages/create-electro-start/src/install.ts`

### Action authoring

- [Main functions](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/index.ts): `packages/electro-start/src/index.ts`
- [Function IDs](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/id.ts): `packages/electro-start/src/id.ts`
- [Wire serialization](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/serialize.ts): `packages/electro-start/src/serialize.ts`
- [Query API](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/query/index.ts): `packages/electro-start/src/query/index.ts`

### Webview client

- [Vite transform](https://github.com/mellofordev/electro-start/blob/master/packages/vite-plugin/src/index.ts): `packages/vite-plugin/src/index.ts`
- [Client stubs](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/client/stub.ts): `packages/electro-start/src/client/stub.ts`
- [Client errors](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/client/errors.ts): `packages/electro-start/src/client/errors.ts`
- [Client initialization](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/client/index.ts): `packages/electro-start/src/client/index.ts`

### Bun runtime

- [Bun plugin](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/bun-plugin.ts): `packages/electro-start/src/bun-plugin.ts`
- [Function discovery](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/runtime/discovery.ts): `packages/electro-start/src/runtime/discovery.ts`
- [Runtime startup](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/runtime/index.ts): `packages/electro-start/src/runtime/index.ts`
- [Function registry](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/runtime/registry.ts): `packages/electro-start/src/runtime/registry.ts`
- [RPC bridge](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/runtime/rpc.ts): `packages/electro-start/src/runtime/rpc.ts`
- [Call handler](https://github.com/mellofordev/electro-start/blob/master/packages/electro-start/src/runtime/handler.ts): `packages/electro-start/src/runtime/handler.ts`

### Other components

- **App developer**
- **React webview**
- **Electrobun bridge**

## Connections

- App developer → Scaffold CLI: runs (evidence: `README.md`)
- Scaffold CLI → Argument parsing: parses arguments (evidence: `packages/create-electro-start/src/index.ts`)
- Scaffold CLI → Setup prompts: resolves options (evidence: `packages/create-electro-start/src/index.ts`)
- Scaffold CLI → Template scaffolding: scaffolds project (evidence: `packages/create-electro-start/src/index.ts`)
- Scaffold CLI → Dependency install: installs dependencies (evidence: `packages/create-electro-start/src/index.ts`)
- Setup prompts → Argument parsing: uses parsed options (evidence: `packages/create-electro-start/src/prompts.ts`)
- App developer → Main functions: defines functions (evidence: `README.md`)
- Main functions → Function registry: registers handlers (evidence: `packages/electro-start/src/index.ts`)
- Main functions → Client stubs: creates client stubs (evidence: `packages/electro-start/src/index.ts`)
- Main functions → Function IDs: exports ID helper (evidence: `packages/electro-start/src/index.ts`)
- Main functions → Wire serialization: exports wire types (evidence: `packages/electro-start/src/index.ts`)
- Main functions → Vite transform: uses with transform (evidence: `README.md`)
- Vite transform → React webview: generates webview stubs (evidence: `README.md`)
- React webview → Client stubs: invokes function (evidence: `README.md`)
- Client stubs → Wire serialization: encodes call (evidence: `packages/electro-start/src/client/stub.ts`)
- Client stubs → Client errors: raises remote errors (evidence: `packages/electro-start/src/client/stub.ts`)
- Client initialization → Client stubs: installs dispatcher (evidence: `packages/electro-start/src/client/index.ts`)
- Client stubs → Electrobun bridge: dispatches RPC (evidence: `README.md`)
- Electrobun bridge → RPC bridge: forwards call (evidence: `README.md`)
- Bun plugin → Function discovery: starts discovery (evidence: `packages/electro-start/src/bun-plugin.ts`)
- Runtime startup → Function discovery: discovers functions (evidence: `packages/electro-start/src/runtime/index.ts`)
- Runtime startup → RPC bridge: wires RPC (evidence: `packages/electro-start/src/runtime/index.ts`)
- Runtime startup → Function registry: uses registry (evidence: `packages/electro-start/src/runtime/index.ts`)
- Function discovery → Function IDs: derives IDs (evidence: `packages/electro-start/src/runtime/discovery.ts`)
- RPC bridge → Call handler: routes calls (evidence: `packages/electro-start/src/runtime/rpc.ts`)
- Call handler → Function registry: looks up handler (evidence: `packages/electro-start/src/runtime/handler.ts`)
- Call handler → Wire serialization: decodes and encodes (evidence: `packages/electro-start/src/runtime/handler.ts`)
- Query API → Main functions: builds on API (evidence: `packages/electro-start/src/query/index.ts`)
