Skip to content
KUKAN KUKAN

Quick Start

Prerequisites

Section titled “Prerequisites”
  • Node.js 24+
  • pnpm 9+
  • Docker / Docker Compose

Setup

Section titled “Setup”

1. Clone the repository

Section titled “1. Clone the repository”
Terminal window
git clone https://github.com/kukan-project/kukan.git
cd kukan

2. Install dependencies

Section titled “2. Install dependencies”
Terminal window
pnpm install

3. Start infrastructure

Section titled “3. Start infrastructure”

Start PostgreSQL, MinIO, ElasticMQ, and OpenSearch with Docker Compose.

Terminal window
docker compose up -d

4. Environment variables

Section titled “4. Environment variables”
Terminal window
cp .env.example .env

5. Run database migrations

Section titled “5. Run database migrations”
Terminal window
pnpm db:migrate

6. Create initial user

Section titled “6. Create initial user”

Create the first sysadmin (system administrator) user.

Terminal window
pnpm db:create-user --email admin@example.com --name admin --password <password> --role sysadmin

You can also create regular users (--role defaults to user when omitted).

Terminal window
pnpm db:create-user --email user@example.com --name taro --password <password>

7. Start the development server

Section titled “7. Start the development server”
Terminal window
pnpm dev

Access the application at http://localhost:3000.