LabCode

自動実験プロトコル言語プラットフォーム

クイックスタート

1. リポジトリのクローン

git clone --recurse-submodules <repository-url>
cd labcode-test-environment

2. ビルド & 起動

docker compose build
docker compose up -d

3. 初回ユーザー作成

curl -X POST "http://localhost:8000/api/users/" -d "email=your-email@example.com"

4. アクセス

サービス	URL
Web UI	http://localhost:5173
Admin Panel	http://localhost:5173/admin
API (Swagger UI)	http://localhost:8000/docs

---

ドキュメント

詳細なドキュメントは docs/ フォルダを参照してください。

ドキュメント	説明
クイックスタート	詳細なセットアップ手順
システムアーキテクチャ	システム構成
Admin Panel	管理画面の機能
API リファレンス	API エンドポイント一覧
アップグレードガイド	既存環境からのアップグレード
S3ストレージ設定	AWS S3連携設定
DB自動初期化	データベース初期化の仕組み
リモートアクセス	他PCからのアクセス設定

---

アーキテクチャ

graph TB
    subgraph Docker["labcode-test-environment"]
        subgraph Frontend["Web UI"]
            WebApp["labcode-web-app<br/>React + Vite<br/>Port: 5173"]
        end

        subgraph Backend["Backend API"]
            LogServer["labcode-log-server<br/>FastAPI + SQLite<br/>Port: 8000"]
        end

        subgraph Simulator["Simulator"]
            Sim["labcode-sim<br/>Port: 8888"]
        end

        subgraph Storage["Storage"]
            DB[(SQLite<br/>Database)]
            S3[(AWS S3<br/>Optional)]
        end
    end

    WebApp <--> LogServer
    LogServer <--> Sim
    LogServer --> DB
    LogServer --> S3
    Sim --> S3

Loading

---

コンテナ操作

# 停止
docker compose down

# 再起動
docker compose restart

# ログ確認
docker compose logs -f

# 再ビルド
docker compose build --no-cache
docker compose up -d

---

トラブルシューティング

「Internal Error」が表示される

ユーザーが作成されていない可能性があります。初回ユーザー作成を実行してください。

curl -X POST "http://localhost:8000/api/users/" -d "email=your-email@example.com"

コンテナが起動しない

# ログを確認
docker compose logs log_server

# 再ビルド
docker compose build --no-cache
docker compose up -d

詳細は docs/00_quickstart.md のトラブルシューティングセクションを参照してください。

---

ライセンス

LICENSE を参照してください。