セットアップ

概要

ゲーム開発のケーススタディプロジェクトの開発環境セットアップ手順を説明します。

前提条件

ソフトウェア	バージョン	備考
Docker	最新	開発環境の構築に必要
Docker Compose	最新	複数コンテナの管理に必要
Git	最新	バージョン管理に必要
Node.js	最新	Gulpタスクの実行に必要
npm	最新	パッケージ管理に必要

セットアップ手順

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

git clone https://github.com/k2works/ai-programing-exercise.git
cd case-study-game-dev

2. 依存関係のインストール

npm install

3. ドキュメント環境の起動

Dockerを使用した方法

# ドキュメントサーバーの起動
npm run docs:serve

# または直接docker-composeを使用
docker-compose up mkdocs

ドキュメントは http://localhost:8000 でアクセス可能です。

ドキュメントサーバーの停止

npm run docs:stop

4. ドキュメントのビルド

npm run docs:build

プロジェクト構成

case-study-game-dev/
├── app/                    # アプリケーションコード
├── docs/                   # ドキュメント
│   ├── adr/               # アーキテクチャ決定ログ
│   ├── assets/            # ドキュメント用アセット
│   ├── development/       # 開発ドキュメント
│   ├── journal/           # 開発日誌
│   ├── operation/         # 運用ドキュメント
│   ├── reference/         # リファレンス
│   ├── requirements/      # 要件定義
│   └── Dockerfile         # MkDocs用Dockerfile
├── script/                # Gulpタスクスクリプト
├── docker-compose.yml     # Docker Compose設定
├── gulpfile.js           # Gulpタスク定義
├── mkdocs.yml            # MkDocs設定
└── package.json          # Node.js依存関係

利用可能なコマンド

コマンド	説明
npm run journal	開発日誌の生成
npm run docs:serve	ドキュメントサーバーの起動
npm run docs:stop	ドキュメントサーバーの停止
npm run docs:build	ドキュメントのビルド

ドキュメント機能

対応する図表形式

• Mermaid図: フローチャート、シーケンス図などの描画
• PlantUML図: UML図の描画（専用サーバー連携）

カスタムスタイル

• レスポンシブ対応の図表表示
• エラーハンドリング機能付きPlantUML画像表示
• カスタムCSS/JSによる拡張機能

トラブルシューティング

Dockerコンテナが起動しない場合

1. Dockerサービスが実行中か確認
2. ポート8000が他のプロセスで使用されていないか確認
3. docker-compose down でコンテナを停止後、再起動

PlantUML図が表示されない場合

PlantUMLサーバーコンテナが正常に起動しているか確認してください：

docker-compose logs plantuml

関連ドキュメント

• 開発ドキュメント
• アーキテクチャ概要
• 要件定義