Johannes Kresner
bba0095bc0
Establish the monorepo, tooling, and starter apps so UI and gateway development can begin from a documented, runnable baseline.
34 lines
1.4 KiB
Markdown
34 lines
1.4 KiB
Markdown
# Vela
|
|
|
|
Vela is a local-first, voice-first assistant designed around a browser PWA, a gateway service, and self-hosted integrations for speech, LLM orchestration, home automation, search, and speech synthesis.
|
|
|
|
## Documentation
|
|
|
|
- [Project overview](docs/overview.md)
|
|
- [Architecture](docs/architecture.md)
|
|
- [Event protocol and state machine](docs/protocol.md)
|
|
- [Integrations and tool safety](docs/integrations.md)
|
|
- [Deployment and operations](docs/deployment.md)
|
|
- [Setup and workspace usage](docs/setup.md)
|
|
- [Phased backlog](docs/backlog.md)
|
|
- [README migration map](docs/readme-migration-map.md)
|
|
|
|
## Development
|
|
|
|
- Use **mise** for tooling in this repository.
|
|
- Use **Yarn** as the package manager once provisioned by mise.
|
|
- Bootstrap tools with `mise install`.
|
|
- Run repo commands with `mise exec -- yarn …` if your shell is not activated for mise.
|
|
- Install workspace dependencies with `mise exec -- yarn install`.
|
|
- Start the SvelteKit UI with `mise exec -- yarn dev:ui`.
|
|
- Start the Fastify gateway with `mise exec -- yarn dev:gateway`.
|
|
- Build the UI with `mise exec -- yarn build:ui` and run the UI check with `mise exec -- yarn check:ui`.
|
|
|
|
## Working Agreement
|
|
|
|
- [AGENTS.md](AGENTS.md) defines how implementation work and documentation should stay aligned.
|
|
|
|
## Status
|
|
|
|
The repository now includes a minimal runnable SvelteKit UI and a minimal runnable Fastify gateway as the baseline for the next vertical slices.
|