examples/

directory
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2026 License: Apache-2.0

README

Deployment Examples

Docker Compose configurations for different deployment scenarios.

Examples

Example Description Use Case
dev Builds from source (local Dockerfile) Local development
quickstart Uses pre-built ghcr.io images Quick setup, production

Prerequisites

  • Docker and Docker Compose
  • 4GB+ RAM recommended

Quick Start

# For development (builds from source)
cd examples/dev
docker compose up -d

# For quickstart (pre-built images)
cd examples/quickstart
docker compose up -d

UI Development

The UI is developed separately using Next.js dev server with hot reload:

# Start backend (from examples/dev)
docker compose up -d

# Start UI dev server (from ui/)
cd ui
npm run dev   # Runs on http://localhost:3000

The UI connects to the backend at localhost:8080 via the NEXT_PUBLIC_API_URL environment variable.

Directories

Path Synopsis
dev

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL