todo-for-ai

环境要求

• Docker 环境（官方推荐的部署方式，镜像已包含全部组件）
• 一个可访问的 MySQL 数据库，并提供连接串
• Node.js 与 npm（用于安装 @todo-for-ai/mcp 或构建前端/MCP）
• Python 3 与 pip（仅源码方式运行 Flask 后端时需要）

安装与启动步骤

1. 1Docker 一键启动

   拉取并后台运行官方镜像，映射 50111(Web) 与 50110(API) 端口，需替换数据库、邮箱与密钥等占位值。

   docker run -d --name todo-for-ai 
     -p 50111:80 
     -p 50110:50110 
     -e DATABASE_URL="mysql+pymysql://username:password@host.docker.internal:3306/todo_for_ai" 
     -e GMAIL_USER="your-email@gmail.com" 
     -e GMAIL_PASSWORD="your-app-password" 
     -e GITHUB_TOKEN="your-github-token" 
     -e SECRET_KEY="your-secret-key-here" 
     -e JWT_SECRET_KEY="your-jwt-secret-key-here" 
     --add-host=host.docker.internal:host-gateway 
     todoforai/todo-for-ai:latest

   复制

2. 2Docker Compose 启动

   开发者方式：复制环境变量模板并编辑后，用 compose 在仓库中一键起服务。

   cp .env.example .env
   docker-compose up -d

   复制

3. 3安装 MCP 服务

   通过 npm 全局安装 MCP 包，让 Cursor、Windsurf、Trae 等 AI 工具接入任务管理能力。

   npm install -g @todo-for-ai/mcp

   复制

4. 4编写 MCP 配置

   在 config.json 中填写 MCP 主机端口、后端 API 地址、JWT token 与功能开关后供 AI 工具加载。

5. 5源码部署后端

   递归克隆仓库，进入 API 子目录安装依赖并启动 Flask 后端。

   git clone --recursive https://github.com/todo-for-ai/todo-for-ai.git
   cd todo-for-ai/todo-for-ai-api-server
   pip install -r requirements.txt
   python app.py

   复制

6. 6源码部署前端

   新开一个终端，进入前端目录安装依赖、构建并预览 Web 界面。

   cd ../todo-for-ai-webpage
   npm install
   npm run build
   npm run preview

   复制

7. 7源码部署 MCP

   再开一个终端，进入 MCP 目录安装依赖、构建并启动 MCP 服务。

   cd ../todo-for-ai-mcp
   npm install
   npm run build
   npm start

   复制

关键配置

如何确认成功

浏览器访问 http://localhost:50111 能看到 Web 界面，并用 lsof -i :50110 和 lsof -i :50111 确认端口已被监听。

常见问题

注意事项

• Docker 部署必须加 --add-host=host.docker.internal:host-gateway，否则容器内无法访问宿主机上的 MySQL。
• 生产环境请把 SECRET_KEY、JWT_SECRET_KEY 换成复杂强密码，并配置 HTTPS 与数据库自动备份。
• Gmail 发送邮件需先开启两步验证并生成应用专用密码，不能直接使用账号登录密码。
• 源码方式会同时运行后端、前端和 MCP 三个服务，需要在三个独立终端中分别启动。