MCP Todo

🚀 MCP Todo

通过 WebSocket 实现的任务管理 API，支持命令行工具和人工智能工具的集成。使用 TypeScript 和 SQLite 数据库开发，为任务管理提供高效、便捷的解决方案。

🚀 快速开始

先决条件

在运行项目之前，请确保安装以下内容：

• Node.js v20 或更高版本
• npm v10 或更高版本
• Git

运行项目

1. 确保 Husky 提交钩子有执行权限

chmod +x .husky/pre-commit

⚠️ 重要提示

确保在尝试 git commit 时，pre-commit 钩子能够正确执行。

2. 启动开发服务器

npm run dev

💡 使用建议

使用 ts-node 运行应用。

3. 检查 Git 仓库是否已初始化

git rev-parse --is-inside-work-tree

⚠️ 重要提示

确认当前目录是否处于 Git 仓库内，这对于 Husky 和 lint-staged 等工具的运行至关重要。

🧪 执行测试

npm run test

💡 使用建议

使用 Jest 运行测试套件。

🛠️ 可用脚本

📋 报告与结果

• ✅ 构建/测试状态：GitHub Actions 的最新运行状态通过顶部的 badge 显示。
• 📦 可用构建包：
  • build-artifact (📁 ./dist) – 包含构建过程中生成的所有文件。
  • coverage (📁 ./coverage) – 详细的测试覆盖率报告，可在 coverage/lcov-report/index.html 查看。
• 🔗 访问构建包：所有生成的构建包位于 Actions 页面。