Skip to content

Getting Started

The full step-by-step operations manual lives in the repo root at RUNNING.md — this page is the condensed version.

Prerequisites

  • Docker + Docker Compose v2
  • Ports free: 3010, 4001, 5173, 5432, 5672, 15672, 9000, 9001, 6333

Start everything

bash
docker compose up -d --build
docker compose exec core-api npx prisma migrate deploy
docker compose exec core-api npm run seed

This starts 12 containers: Postgres, RabbitMQ, MinIO, Qdrant, the Core Warehouse API, the React frontend, three sample Plugin Workers (Markdown Summarizer, Vector Embedder, GitHub Profile Scanner), the Community Plugin Registry API, the standalone Community site, and the docs site.

Use it

Register a resource from the UI or via curl:

bash
curl -s -X POST http://localhost:3010/api/v1/resources \
  -H 'Content-Type: application/json' \
  -d '{"name":"My Doc","type":"MARKDOWN","source":{"kind":"URL","url":"https://raw.githubusercontent.com/octocat/Hello-World/master/README"}}'

Poll GET /api/v1/resources/{id} and watch status move from PENDING to PROCESSING to COMPLETED, with artifacts appearing as each step finishes. Click an artifact chip in the UI to view its actual content.

Running the test suite

bash
docker compose -p kuraio-test -f docker-compose.test.yml up -d
cd backend && npm install && npx prisma migrate deploy && npm run test:integration

Always pass -p <a-different-name> with docker-compose.test.yml — otherwise Compose treats it as redefining the main stack's containers (same service names) and will replace your running demo.

See RUNNING.md for troubleshooting, local dev without Docker, and more.