license	AGPL-3.0-or-later
title	Sunbeam Kanban
description	Real-time collaborative board management for Sunbeam Studios.
category	product
order	0
nav_order	0
labels	org repo package sunbeam kanban kanban

Sunbeam Kanban

Real-time collaborative board management for Sunbeam Studios. Organize cards across projects, share with teammates, link to GitHub issues, search globally, and see changes sync live across tabs and devices.

Quick links

• Product overview — what Kanban is and who it is for.
• Features — boards, cards, templates, search, GitHub linking, attachments.
• Templates — board and card templates.
• Deployment — Kubernetes deployment, image build, rollout/rollback.
• Configuration — environment variables and Secrets.
• Observability — metrics, traces, logs, alerts.
• Runbooks — operational playbooks.
• Architecture — request path, real-time flow, service map.
• Testing — how to run backend and frontend tests.
• Adding an RPC — recipe for extending the API.
• Security — authz/authn, header checks, namespace evolution.
• AGENTS.md — AI agent guide for this repo.

Development stack

• Backend: Rust (Axum, SQLx, NATS, Sunbeam Studios' SSO Gateway).
• Transport: Connect-RPC over h2 with SSE fallback.
• Realtime: NATS JetStream fanout and replay.
• Auth: Sunbeam Studios' SSO Gateway (unified OAuth2 + OpenFGA permissions).
• Database: PostgreSQL.
• Search: OpenSearch.
• Object storage: S3-compatible store for attachments.

Run locally

Start the shared services from the workspace root:

cd /Users/sienna/Development/sunbeam
sunbeam ops compose up kanban

Then run the backend:

cargo run --bin kanban      # :8080

For test commands and local setup, see Testing.

Deploy

The service is stateless and runs as a Kubernetes Deployment. The container image supports linux/amd64 and linux/arm64. See Deployment for the full guide.

Where to report issues

Report bugs on Gitea. For security issues, email security@sunbeam.pt instead of opening a public issue.