Files
assistant/docs/setup.md

1.8 KiB

Vela Setup and Workspace Layout

Tooling and Package Management

  • Use mise to provision repo tools.
  • Use Yarn for dependency management and workspace commands in this repository.

The repo-level tool configuration lives in mise.toml.

Workspace Layout

apps/
  vela-ui/
  vela-gateway/
docs/
AGENTS.md
README.md
mise.toml
package.json

Workspace Purpose

apps/vela-ui

  • minimal SvelteKit browser application
  • current starter page confirms the workspace boots correctly
  • intended to grow into the SvelteKit PWA implementation

apps/vela-gateway

  • minimal Fastify gateway service
  • current HTTP endpoints provide a runnable baseline at / and /health
  • intended to grow into the WebSocket session and orchestration layer

Initial Commands

Install repo tools:

mise install

Install dependencies:

mise exec -- yarn install

Run the current workspaces:

mise exec -- yarn dev:ui
mise exec -- yarn dev:gateway

Additional verification commands:

mise exec -- yarn check:ui
mise exec -- yarn build:ui
mise exec -- yarn build:gateway
npm run test --workspace vela-ui

Notes

  • the concrete framework choices are now SvelteKit for vela-ui and Fastify for vela-gateway
  • the UI is intentionally minimal and currently includes only a developer-facing WebSocket voice-session shell
  • the UI now renders a deterministic mocked transcript and assistant response flow, but does not yet include mic capture or audio playback
  • the gateway now exposes the minimal shared-protocol /ws WebSocket contract used by that shell
  • if your shell is configured for mise activation, plain yarn commands can be used after mise install
  • update this document when the repo layout or package manager workflow changes