How mellofordev/electro-start works
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: src/index.ts Main functions · stub.ts Client stubs · src/index.ts Scaffold CLI · runtime/index.ts Runtime startup
Components 22
Project scaffolding
- Scaffold CLI
packages/create-electro-start/src/index.ts - Argument parsing
packages/create-electro-start/src/args.ts - Setup prompts
packages/create-electro-start/src/prompts.ts - Template scaffolding
packages/create-electro-start/src/scaffold.ts - Dependency install
packages/create-electro-start/src/install.ts
Action authoring
- Main functions
packages/electro-start/src/index.ts - Function IDs
packages/electro-start/src/id.ts - Wire serialization
packages/electro-start/src/serialize.ts - Query API
packages/electro-start/src/query/index.ts
Webview client
- Vite transform
packages/vite-plugin/src/index.ts - Client stubs
packages/electro-start/src/client/stub.ts - Client errors
packages/electro-start/src/client/errors.ts - Client initialization
packages/electro-start/src/client/index.ts
Bun runtime
- Bun plugin
packages/electro-start/src/bun-plugin.ts - Function discovery
packages/electro-start/src/runtime/discovery.ts - Runtime startup
packages/electro-start/src/runtime/index.ts - Function registry
packages/electro-start/src/runtime/registry.ts - RPC bridge
packages/electro-start/src/runtime/rpc.ts - Call handler
packages/electro-start/src/runtime/handler.ts
Other components
- App developer
- React webview
- Electrobun bridge
Connections 28
- App developer → Scaffold CLI: runs
README.md - Scaffold CLI → Argument parsing: parses arguments
packages/create-electro-start/src/index.ts - Scaffold CLI → Setup prompts: resolves options
packages/create-electro-start/src/index.ts - Scaffold CLI → Template scaffolding: scaffolds project
packages/create-electro-start/src/index.ts - Scaffold CLI → Dependency install: installs dependencies
packages/create-electro-start/src/index.ts - Setup prompts → Argument parsing: uses parsed options
packages/create-electro-start/src/prompts.ts - App developer → Main functions: defines functions
README.md - Main functions → Function registry: registers handlers
packages/electro-start/src/index.ts - Main functions → Client stubs: creates client stubs
packages/electro-start/src/index.ts - Main functions → Function IDs: exports ID helper
packages/electro-start/src/index.ts - Main functions → Wire serialization: exports wire types
packages/electro-start/src/index.ts - Main functions → Vite transform: uses with transform
README.md - Vite transform → React webview: generates webview stubs
README.md - React webview → Client stubs: invokes function
README.md - Client stubs → Wire serialization: encodes call
packages/electro-start/src/client/stub.ts - Client stubs → Client errors: raises remote errors
packages/electro-start/src/client/stub.ts - Client initialization → Client stubs: installs dispatcher
packages/electro-start/src/client/index.ts - Client stubs → Electrobun bridge: dispatches RPC
README.md - Electrobun bridge → RPC bridge: forwards call
README.md - Bun plugin → Function discovery: starts discovery
packages/electro-start/src/bun-plugin.ts - Runtime startup → Function discovery: discovers functions
packages/electro-start/src/runtime/index.ts - Runtime startup → RPC bridge: wires RPC
packages/electro-start/src/runtime/index.ts - Runtime startup → Function registry: uses registry
packages/electro-start/src/runtime/index.ts - Function discovery → Function IDs: derives IDs
packages/electro-start/src/runtime/discovery.ts - RPC bridge → Call handler: routes calls
packages/electro-start/src/runtime/rpc.ts - Call handler → Function registry: looks up handler
packages/electro-start/src/runtime/handler.ts - Call handler → Wire serialization: decodes and encodes
packages/electro-start/src/runtime/handler.ts - Query API → Main functions: builds on API
packages/electro-start/src/query/index.ts