mcpField
S
setup-ai-tutor

setup-ai-tutor

github.com/coleam00Development722206 installsUpdated 3w ago
Repository

About setup-ai-tutor

A setup skill for running the AI Tutor project locally. It guides developers through environment configuration, dependency installation, database migration, server startup, and health checks.

Key features

  1. 01Creates a local environment file
  2. 02Installs Python dependencies with uv
  3. 03Starts PostgreSQL using Docker Compose
  4. 04Runs Alembic database migrations
  5. 05Starts a reload-enabled FastAPI server
  6. 06Checks API and database health

Use cases

  1. 01Preparing a local AI Tutor instance
  2. 02Applying pending database migrations
  3. 03Verifying API and database availability

Install

Copy the command and run it in a terminal.

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

After installing, type/setup-ai-tutorin Claude Code to confirm it loaded.

Details

From the project README

Set Up the AI Tutor Locally

Run the following commands to set up and start the AI Tutor locally.

Input

None required. Run from the repository root.

Process

1. Create Environment File
cp .env.example .env

Creates your local environment configuration from the example template.

2. Install Dependencies
uv sync

Installs all Python packages defined in pyproject.toml.

3. Start Database
docker-compose up -d db

Starts PostgreSQL in a Docker container.

4. Run Database Migrations
uv run alembic upgrade head

Applies all pending database migrations.

5. Start Development Server
uv run uvicorn app.main:app --reload --port 8123

Starts the FastAPI server with hot-reload on port 8123.

6. Validate Setup

Check that everything is working:

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

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

Both should return {"status":"healthy"} responses.

Output

A running local AI Tutor instance.

Access Points

Cleanup

To stop services:

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

Notes

  • Port numbers and the exact docker-compose service name may differ — check docker-compose.yml, .env.example, and the project README for project-specific values before running.

Comments

Markdown supported