chore: kanban template
This commit is contained in:
40
README.md
Normal file
40
README.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Kanban Board Template
|
||||
|
||||
Production-style Fabric demo template that exercises all core surfaces in one project:
|
||||
|
||||
- `http` - board APIs + workflow start routes
|
||||
- `channel` - `/ws/kanban` connect/message handlers
|
||||
- `queue` - `kanban-health-check` worker
|
||||
- `schedule` - periodic health-check trigger
|
||||
- `workflow` - demo orchestration workflow
|
||||
- `mcp` - exposed command endpoint (`mcpKanbanCommand`)
|
||||
- `agent` - `kanbanOpsAgent` with tool wiring
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. `yarn install`
|
||||
2. `yarn workspace @project/functions pikku db migrate`
|
||||
3. `yarn prebuild`
|
||||
4. `yarn dev`
|
||||
5. Open `/kanban`
|
||||
|
||||
## Demo RPCs
|
||||
|
||||
- `listKanbanCards`
|
||||
- `getKanbanMetric`
|
||||
- `getKanbanWorkflowStatus`
|
||||
- `createKanbanCard`
|
||||
- `moveKanbanCard`
|
||||
- `enqueueKanbanHealthCheck`
|
||||
- `startKanbanDemoWorkflow`
|
||||
- `mcpKanbanCommand`
|
||||
|
||||
## Template Conventions
|
||||
|
||||
- Same workspace and deploy layout as Fabric `starter-template`
|
||||
- Root `pikku.config.json` and `packages/functions/pikku.config.json` preserved
|
||||
- SQL migrations live in `db/migrations/`
|
||||
- Optional `db/seed.sql` runs only via `pikku db seed` / `pikku db reset`
|
||||
- DB types regenerate at `packages/functions/.pikku/db/schema.d.ts` on every `pikku db migrate`
|
||||
- UI routes live in `apps/kanban/src/routes/` (TanStack Start, SSR on Cloudflare)
|
||||
- Shared widgets/components live in `packages/components/`
|
||||
Reference in New Issue
Block a user