開発者向けクイックスタートガイド
前提知識レベル:
- 基本的なGit操作
- Node.js/npm (またはyarn)
- DockerおよびDocker Composeの基礎知識
- React, FastAPIに関する基本的な開発経験
1. 概要
このガイドは、開発者がGraphVisAgentのローカル開発環境をセットアップし、アプリケーションを起動するまでの手順を説明します。
本システムは、フロントエンド、バックエンド、計算サービス、データベースの複数のコンテナーで構成されています。これらはDocker Composeを用いて一括で管理されます。
注意: このドキュメントリポジトリ (GraphVisAgent-docs) は仕様書のみを管理しています。実際のソースコードは本体の GraphVisAgent リポジトリにあります。以下の手順は、本体リポジトリのルートディレクトリで実行することを想定しています。
2. 環境構築手順
ステップ1: リポジトリのクローン
git clone https://github.com/<your-org>/GraphVisAgent.git
cd GraphVisAgent
ステップ2: 環境変数の設定
プロジェクトルートにある .env.example ファイルをコピーして .env ファイルを作成します。
cp .env.example .env
その後、.env ファイルをエディターで開き、外部LLMサービスのAPIキーなど、必要な環境変数を設定してください。
# .env
OPENAI_API_KEY="sk-..."
# GOOGLE_API_KEY="..." # 必要に応じて
ステップ3: 依存関係のインストール
本プロジェクトのフロントエンドは yarn を使用します。
# フロントエンドの依存関係をインストール
cd frontend
yarn install
cd ..
(バックエンドの依存関係はDockerビルド時にインストールされます)
ステップ4: アプリケーションの起動
プロジェクトルートからDocker Composeを起動します。これにより、すべてのサービスがビルドされ、起動します。
docker compose up --build
初回起動時はビルドに時間がかかることがあります。
ステップ5: アプリケーションへのアクセス
ビルドと起動が正常に完了したら、Webブラウザで以下のURLにアクセスします。
- フロントエンド (アプリケーション本体):
http://localhost:3000 - バックエンドAPIドキュメント (Swagger UI):
http://localhost:8000/docs
3. トラブルシューティング
- ポートが競合する場合:
docker compose.ymlや.envファイルで、各サービスが使用するポート番号を適宜変更してください。 - ビルドに失敗する場合: Dockerデーモンのリソース割り当て（メモリ、CPU）が十分であるか確認してください。また、Dockerfile内の依存関係のバージョンに問題がないか確認します。
これでローカル開発環境の準備は完了です。各コンポーネントのより詳細なアーキテクチャやAPI仕様については、詳細技術仕様を参照してください。