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 頁面。