Requirements

Use this checklist before starting the Quickstart.

Required tools

Tool	Version	Used for
Bun	1.4 or newer	runtime, package manager, tests, and builds
Docker	a current release with Compose v2	local PostgreSQL and Redis
curl	any current release	downloading the installer
OpenSSL	any current release	generating local development keys

The quickstart installer adds Bun through the official bun.sh installer when Bun is missing. Install and start Docker yourself before running docker compose.

The scaffold is development-ready, not production-ready

The recommended scaffold can boot locally without production infrastructure. Before deploying it, configure TZ=UTC, a KMS for PII and blind indexes, and a persistent file provider for GDPR exports. The local boot warnings are expected until those production concerns are configured; they are not a replacement for a deployment check. See Load encryption keys from a key manager and Deploy: Docker before shipping.

Check your machine:

bun --version
docker --version
docker compose version
curl --version
openssl version

It is fine if only bun --version fails before the quickstart. Every other command should print a version.

Windows users should run the commands in WSL.

Local services and ports

A newly scaffolded app’s docker-compose.yml starts:

Service	Local port	Used for
PostgreSQL 18	5432	event store and read projections
Redis 7	6379	live updates, rate limiting, and caching

The development server normally listens on port 4173.

Check whether those ports are already occupied:

lsof -nP -iTCP:5432 -sTCP:LISTEN
lsof -nP -iTCP:6379 -sTCP:LISTEN
lsof -nP -iTCP:4173 -sTCP:LISTEN

No output means the port is free. On Linux without lsof, use ss -ltn and look for the same port numbers.

If a port is occupied, stop the existing service or change the Compose mapping and its matching URL in .env. For the web server, start with another port:

PORT=4174 bun dev

Optional tools

• Node.js is needed only for workflows that explicitly invoke Node, such as some Astro tooling. Kumiko apps run on Bun.
• GitHub CLI (gh) is useful for repository and issue work.
• Pulumi is required only for the K3s deployment path.
• Meilisearch is required only when the app mounts search features that use it.

You do not need

• npm, pnpm, or Yarn
• global TypeScript or Vite installs
• global schema or ORM tools
• a clone of the Kumiko framework repository

The scaffold installs project-local dependencies and manages app migrations through kumiko-schema.

Next steps

• Quickstart
• Deploy to Docker
• Deploy to K3s