mcpField
S
setup-ai-tutor

setup-ai-tutor

github.com/coleam00开发722206 次安装3 周前更新
代码仓库

关于 setup-ai-tutor

这是用于在本地运行 AI Tutor 项目的设置技能，面向开发者。它依次指导配置环境、安装依赖、启动数据库、执行迁移、启动服务器并检查健康状态。

主要功能

  1. 01创建本地环境文件
  2. 02使用 uv 安装 Python 依赖
  3. 03通过 Docker Compose 启动 PostgreSQL
  4. 04运行 Alembic 数据库迁移
  5. 05启动支持热重载的 FastAPI 服务
  6. 06检查 API 与数据库状态

适用场景

  1. 01准备本地 AI Tutor 实例
  2. 02应用待执行的数据库迁移
  3. 03验证 API 和数据库是否可用

安装

复制下面的命令，在终端中运行。

$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