Skip to content

Quickstart

Available for local development

The current supported path is the repository-root Docker Compose environment. It is development infrastructure, not a production deployment architecture.

  • Docker with the Compose plugin
  • Host ports 5173, 7880, 7881, 8000, 8025, 8081, 5432, 6379, and 7700
  • UDP port 7882

Host installations of PHP, Composer, Node.js, PostgreSQL, Redis, and Meilisearch are optional when Compose is used.

From the Katra repository root:

Terminal window
docker compose up --build

The first build installs Client and Server dependencies in named volumes. Katra Server waits for PostgreSQL, Redis, and Meilisearch, applies pending migrations, and then starts.

Open the Client at http://localhost:5173. Create a local account at /register using a password of at least 12 characters.

Terminal window
docker compose ps
docker compose exec server php artisan katra:foundation:check

The foundation check verifies PostgreSQL, Redis, queue selection, Reverb broadcast selection, and Meilisearch health.

Terminal window
docker compose down

Named volumes preserve PostgreSQL, Redis, Meilisearch, Mailpit, and installed dependencies.