MCP Todo

🚀 MCP Todo

A task management API implemented via WebSocket, supporting integration with command-line tools and AI tools. Developed with TypeScript and SQLite database.

🚀 Quick Start

Prerequisites

Before running the commands below, make sure you have the following installed:

• Node.js v20 or higher
• npm v10 or higher
• Git

Running the Project

1. Ensure that the Husky commit hook has execution permissions:

chmod +x .husky/pre-commit

Ensure that the pre-commit hook can execute correctly when attempting git commit.

2. Start the development server:

npm run dev

Run the application using ts-node.

3. Check if the Git repository is initialized:

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

Confirm whether the current directory is within a Git repository, which is crucial for the operation of tools like Husky and lint-staged.

🧪 Testing

npm run test

Run the test suite using Jest.

🛠️ Available Scripts

• npm run dev: Start the application in development mode, supporting TypeScript.
• npm run test: Run the Jest test suite.
• npm run lint: Run ESLint for code inspection.

📋 Reports and Results

• ✅ Build/Test Status: The latest running status of GitHub Actions is displayed via the badge at the top.
• 📦 Available Build Packages:
  • build-artifact (📁 ./dist) – Contains all files generated during the build process.
  • coverage (📁 ./coverage) – A detailed test coverage report, which can be viewed at coverage/lcov-report/index.html.
• 🔗 Access Build Packages: All generated build packages are located on the Actions page.