Files
huskies/README.md
T

56 lines
1.4 KiB
Markdown
Raw Normal View History

2026-03-28 10:56:36 +00:00
# Storkit
2026-03-28 10:56:36 +00:00
A story-driven development server that manages work items, spawns coding agents, and runs them through a pipeline from backlog to done. Ships as a single Rust binary with an embedded React frontend. Communicates via Matrix, WhatsApp, and Slack bot transports, and exposes MCP tools for programmatic access.
2026-03-28 10:56:36 +00:00
## Prerequisites
2026-03-28 10:56:36 +00:00
- Rust (2024 edition)
- Node.js and npm
- Docker (for Linux cross-compilation and container deployment)
- `cross` (`cargo install cross`) for Linux static builds
2026-03-28 10:56:36 +00:00
## Building for production
```bash
cargo build --release
```
2026-03-28 10:56:36 +00:00
The release binary embeds the frontend via `rust-embed`. Output: `target/release/storkit`.
2026-03-28 10:56:36 +00:00
For a static Linux binary (musl, zero dynamic deps):
```bash
2026-03-28 10:56:36 +00:00
cross build --release --target x86_64-unknown-linux-musl
```
2026-03-28 10:56:36 +00:00
Docker:
```bash
2026-03-28 10:56:36 +00:00
docker compose -f docker/docker-compose.yml build
```
2026-03-28 10:56:36 +00:00
## Running in development
```bash
2026-03-28 10:56:36 +00:00
# Run tests
script/test
2026-03-28 10:56:36 +00:00
# Run the server
cargo run -- --port 3000
2026-03-28 10:56:36 +00:00
# In another terminal, run the frontend dev server
cd frontend && npm install && npm run dev
```
2026-03-28 10:56:36 +00:00
Configuration lives in `.storkit/project.toml`. See `.storkit/bot.toml.*.example` for transport setup.
## Releasing
2026-03-28 10:56:36 +00:00
Requires a Gitea API token in `.env` (`GITEA_TOKEN=your_token`).
```bash
2026-03-28 10:56:36 +00:00
script/release 0.6.1
```
2026-03-28 10:56:36 +00:00
This bumps version in `Cargo.toml` and `package.json`, builds macOS arm64 and Linux amd64 binaries, tags the repo, and publishes a Gitea release with changelog and binaries attached.