mcpField
S
setup-ai-tutor

setup-ai-tutor

github.com/coleam00開発722206 回インストール3 週間前に更新
リポジトリ

setup-ai-tutor について

AI Tutorプロジェクトをローカルで動かすためのセットアップスキルです。開発者向けに、環境設定、依存関係の導入、データベース移行、サーバー起動、ヘルスチェックを順に案内します。

主な機能

  1. 01ローカル環境ファイルの作成
  2. 02uvによるPython依存関係の導入
  3. 03Docker ComposeでPostgreSQLを起動
  4. 04Alembicによるデータベース移行
  5. 05ホットリロード対応FastAPIサーバーの起動
  6. 06APIとデータベースの状態確認

活用シーン

  1. 01ローカルAI Tutor環境の準備
  2. 02保留中のデータベース移行の適用
  3. 03APIとデータベースの稼働確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/coleam00/skills --skill setup-ai-tutor

インストール後、Claude Code で/setup-ai-tutorを入力して読み込まれたか確認します。

詳細

AI Tutor をローカルでセットアップする

以下のコマンドを実行して、AI Tutor をローカルでセットアップし、起動します。

入力

必要ありません。リポジトリのルートから実行してください。

手順

1. 環境ファイルを作成する
cp .env.example .env

サンプルテンプレートからローカル環境設定を作成します。

2. 依存関係をインストールする
uv sync

pyproject.toml で定義されているすべての Python パッケージをインストールします。

3. データベースを起動する
docker-compose up -d db

Docker コンテナ内で PostgreSQL を起動します。

4. データベースのマイグレーションを実行する
uv run alembic upgrade head

保留中のデータベースマイグレーションをすべて適用します。

5. 開発サーバーを起動する
uv run uvicorn app.main:app --reload --port 8123

ポート 8123 でホットリロード機能付きの FastAPI サーバーを起動します。

6. セットアップを検証する

すべてが正常に動作していることを確認します。

# Test API health
curl -s http://localhost:8123/health

# Test database connection
curl -s http://localhost:8123/health/db

どちらも {"status":"healthy"} を返します。

出力

ローカルで実行中の AI Tutor インスタンス。

アクセス先

クリーンアップ

サービスを停止するには、次を実行します。

# Stop dev server: Ctrl+C
# Stop database: docker-compose down

注意事項

  • ポート番号や正確な docker-compose サービス名は異なる場合があります。実行する前に、docker-compose.yml、.env.example、およびプロジェクトの README でプロジェクト固有の値を確認してください。

コメント

Markdown 対応