Skip to content

クイックスタート

完全なステップバイステップの運用マニュアルはリポジトリのルートにある RUNNING.md にあります — このページは その簡略版です。

前提条件

  • Docker + Docker Compose v2
  • 空いているポート: 3010, 4001, 5173, 5432, 5672, 15672, 9000, 9001, 6333

すべてを起動する

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

これにより12個のコンテナが起動します: Postgres、RabbitMQ、MinIO、Qdrant、コアウェアハウスAPI、React フロントエンド、3つのサンプルプラグインワーカー (Markdown Summarizer、Vector Embedder、GitHub Profile Scanner)、コミュニティプラグインレジストリAPI、独立したコミュニティサイト、ドキュメントサイト。

使ってみる

UIから、または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"}}'

GET /api/v1/resources/{id} をポーリングして、statusPENDING から PROCESSINGCOMPLETED へと移り変わり、各ステップが完了するごとに成果物が現れるのを確認してください。UI上の 成果物チップをクリックすると、実際の内容を表示できます。

テストスイートの実行

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

docker-compose.test.yml には必ず -p <別の名前> を指定してください — 指定しないと、Composeは これをメインスタックのコンテナ (同じサービス名) の再定義とみなし、実行中のデモを置き換えてしまいます。

トラブルシューティング、Dockerなしのローカル開発などについては RUNNING.md を参照してください。