External/buzz
1
0
Fork 0
mirror of https://github.com/block/buzz.git synced 2026-08-18 06:50:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: surface README quick start (#443)

Browse Source
This commit is contained in:
Wes
2026-04-30 20:25:32 -07:00
committed by GitHub
parent db6ce12e11
commit 6d4e88b87d
1 changed files with 47 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+47 -47
View File
@@ -11,6 +11,52 @@ structured channels, per-channel canvases, full-text search, and an MCP server s
participate in conversations natively. Authentication is NIP-42 + bearer token; all writes are
append-only and audited.
## Quick Start
Three steps to get the full stack running locally.
**Prerequisites:** Docker, and either [Hermit](https://cashapp.github.io/hermit/) (recommended) or Rust 1.88+, Node.js 24+, pnpm 10+, and [`just`](https://github.com/casey/just) installed manually.
**1. Activate the pinned toolchain**
```bash
. ./bin/activate-hermit
```
Hermit pins Rust, Node.js, pnpm, `just`, and related tooling from `bin/`.
**2. Configure and set up the dev environment**
```bash
cp .env.example .env
just setup
just build
```
`just setup` does the heavy lifting:
- Starts Docker services (Postgres, Redis, Typesense, Adminer, Keycloak, MinIO, Prometheus)
- Waits for core services (Postgres, Redis, Typesense) to be healthy
- Runs database migrations
- Installs desktop dependencies (`pnpm install`)
Then run `just build` once to compile the Rust workspace so binaries like `sprout-acp` and `sprout-mcp-server` are available when you start connecting agents.
**3. Start the relay and desktop app**
```bash
# Terminal 1 — relay
just relay
# Terminal 2 — desktop app
just dev
```
The relay listens on `ws://localhost:3000`. The desktop app opens automatically.
That's it — you're running Sprout locally.
---
## Why Sprout
| | |
@@ -121,52 +167,6 @@ append-only and audited.
| `sprout-admin` | CLI for minting API tokens and listing active credentials |
| `sprout-test-client` | Integration test client and E2E test suite — relay, REST API, tokens, MCP, media, media extended, Nostr interop, and workflows |
## Quick Start
Three steps to get the full stack running locally.
**Prerequisites:** Docker, and either [Hermit](https://cashapp.github.io/hermit/) (recommended) or Rust 1.88+, Node.js 24+, pnpm 10+, and [`just`](https://github.com/casey/just) installed manually.
**1. Activate the pinned toolchain**
```bash
. ./bin/activate-hermit
```
Hermit pins Rust, Node.js, pnpm, `just`, and related tooling from `bin/`.
**2. Configure and set up the dev environment**
```bash
cp .env.example .env
just setup
just build
```
`just setup` does the heavy lifting:
- Starts Docker services (Postgres, Redis, Typesense, Adminer, Keycloak, MinIO, Prometheus)
- Waits for core services (Postgres, Redis, Typesense) to be healthy
- Runs database migrations
- Installs desktop dependencies (`pnpm install`)
Then run `just build` once to compile the Rust workspace so binaries like `sprout-acp` and `sprout-mcp-server` are available when you start connecting agents.
**3. Start the relay and desktop app**
```bash
# Terminal 1 — relay
just relay
# Terminal 2 — desktop app
just dev
```
The relay listens on `ws://localhost:3000`. The desktop app opens automatically.
That's it — you're running Sprout locally.
---
## Going Further
### Mint an API token
@@ -210,7 +210,7 @@ client configuration.
just desktop-dev
```
This starts only the web frontend at `http://localhost:1420` — useful for UI development without rebuilding the Tauri shell. Use `just dev` (from Quick Start) for the full desktop app.
This starts only the web frontend on the worktree-specific Vite port printed by the command. Use `just dev` (from Quick Start) for the full Tauri desktop app.
## Configuration