Kanban Board Application

VibeKanban 🚦🤖

让 Agent 编码更清晰！

欢迎使用 VibeKanban——一个简单、现代的看板，不仅为你而设，也为你的 AI Agent 打造！

✨ 跟踪工作进展。为 Agent 提供上下文。随时了解每一步的动态。

---

为什么选择 VibeKanban？ 🤔

你是否想过，当你让 Agent 修复错误或构建功能时，它实际上在做什么？VibeKanban 搭建起了人工工作流与 Agent 自动化之间的桥梁：

• 📝 可视化看板 — 通过简洁的拖放界面整理项目和工单。
• 🤖 Agent 集成（MCP 服务） — 让 AI Agent 像真正的团队成员一样创建、更新和跟进工单。
• 📊 指标与洞察 — 跟踪部署率、错误频率等数据，了解你（和你的 Agent）的工作状态。
• ⚡ 快速设置 — 只需运行一个脚本，即可开始使用！

---

功能

• 项目管理：创建、查看、编辑和删除项目
• 工单管理：创建和管理工单，并设置类型（bug、story、task、spike）和优先级（low、medium、high、critical）
• 看板视图：支持拖放操作的可视化看板
• MCP 集成：与 Cursor 集成，实现自动创建和更新工单
• DORA 指标：跟踪开发绩效指标

技术栈

• 后端：Python 和 Flask
• 前端：HTML、JavaScript 和 Tailwind CSS
• 数据库：SQLite（本地）

快速设置（推荐）

1. 克隆仓库：

   git clone https://github.com/shahriarb/vibekanban.git
   cd vibekanban
   

2. 运行设置脚本：

   ./setup.sh
   

   此脚本会创建虚拟环境、安装依赖项并设置数据库。

3. 启动应用：

   ./run.sh
   

4. 打开浏览器并访问：

   http://localhost:5050
   

手动设置

如果你倾向于手动设置，或运行脚本时遇到问题：

1. 克隆仓库：

   git clone https://github.com/shahriarb/vibekanban.git
   cd vibekanban
   

2. 创建并激活虚拟环境：

   python3 -m venv .venv
   source .venv/bin/activate   # On Windows, use: .venv\Scripts\activate
   

3. 安装依赖项：

   pip install -r requirements.txt
   

4. 初始化数据库和迁移：

   如果这是你首次设置该项目，请运行：

   flask db init
   flask db migrate -m "Initial migration"
   flask db upgrade
   

   这会根据当前模型创建数据库表。

   如果你已有 migrations/ 文件夹，只需运行：

   flask db upgrade
   

5. 手动运行应用：

   python run.py
   

Python 版本兼容性

此应用已通过 Python 3.13.2 测试。如果你使用 conda 管理 Python，请确保在 .zshrc 文件中激活相应的环境，同时为此应用创建单独的 venv，以避免依赖冲突。

Cursor MCP 集成

要与 Cursor 的 MCP 集成：

1. 确保应用正在运行
2. 在 Cursor 中，前往 Cursor Settings > MCP Servers > Add New Global MCP server

在 Cursor MCP 设置中：

• 名称：KanbanBoard
• 类型：Command
• 命令：/full/path/to/.venv/bin/python /full/path/to/kanban_mcp_server.py

mcp.json 示例：

{
  "mcpServers": {
    "KanbanBoard": {
      "command": "/full/path/to/.venv/bin/python /full/path/to/kanban_mcp_server.py",
      "args": [],
      "enabled": true
    }
  }
}

使用 KanbanBoard MCP

配置完成后，你可以使用以下命令：

• @KanbanBoard get kanban status - 查看各状态下的工单数量
• @KanbanBoard get project ID by name - 按项目名称查找项目 ID
• @KanbanBoard list projects - 列出所有项目
• @KanbanBoard list tickets - 列出所有工单
• @KanbanBoard create ticket - 创建具有指定类型和优先级的新工单
• @KanbanBoard update ticket state - 更新工单状态
• @KanbanBoard add comment - 为工单添加评论

在 Cursor 中使用 MCP 服务的规则示例

You are an AI assistant specialized in software development design and architecture.

Note: Please use @KanbanBoard MCP to document your work in each step. The project_id is <ADD_PROJECT_NUMBER>.
That's a crucial part of the process.

For each feature or improvment request:
- Evaluate the request's complexity to determine if it should be a single ticket or broken into multiple tickets.

- Break Down Subtasks: Identify subtasks for frontend, backend, database, and testing and create them in the @KanbanBoard

- Determine Dependencies: Establish any task dependencies upfront and document them in the @KanbanBoard

- Define Acceptance Criteria: Set clear criteria for each task and document in the @KanbanBoard

- Tailor Testing Methods: For each subtask, define appropriate testing methods. For example, backend tasks might include API tests with tools like Postman or CURL, while frontend tasks might require unit tests with frameworks like Jest. Document the Test Steps in the @KanbanBoard.

- Ticket Flexibility: Allow flexibility to adjust the number of tickets based on ongoing discoveries during development.

- Prioritization: After all tasks defined follow these rules to set the priority for each task:
     - Assess urgency and impact to prioritize critical bugs and high-impact features.
    - Address tasks with dependencies first to unblock other work.
    - Prioritize tasks delivering significant business value.
    - Balance effort and complexity for practical progress.
Set the priority in the @KanbanBoard

- Development: Follow defined acceptance criteria for each task.
    Conduct task-specific testing (unit, integration, end-to-end).

- Ticket Flexibility: Remain flexible to add tasks during development if required.

For each Bug report:
- Create a ticket with the type of 'bug' and add the information I shared with you in the @KanbanBoard. Set clear criteria about what should be fixed and set the priority as high or critical based on the bug's impact.

- Evaluate the reason bug is happening and add findings as the comment to the ticket in the @KanbanBoard.

- Move the ticket to 'in progress' state in the @KanbanBoard and start fixing the bug based on defined criteria.
    
- Move the ticket to 'done' state in the @KanbanBoard when the bug is fixed.

许可证

MIT