Skip to main content

概述

本指南将帮助您搭建 MCPHub 的本地开发环境,了解项目结构,并掌握开发工作流。
前提条件:请确保已安装 Node.js 18+ 和 Git。

环境准备

系统要求

在开始开发之前,请确保您的系统满足以下要求:

软件依赖

  • Node.js: 18.0+ 版本 - npm: 8.0+ 版本 - Git: 最新版本 - Docker: 可选,用于容器化开发

推荐工具

  • VS Code: 推荐的代码编辑器 - Postman: API 测试工具 - TablePlus: 数据库管理工具 - Docker Desktop: 容器管理

验证环境

克隆项目

获取源代码

项目结构

安装依赖

安装项目依赖

全局工具安装

配置开发环境

环境变量配置

开发环境的 .env 配置示例:
.env

启动开发服务器

开发模式启动

后台模式启动

验证启动

访问以下 URL 验证服务是否正常启动:

开发工作流

1. 功能开发流程

2. 代码规范

MCPHub 项目使用以下代码规范工具:

3. 测试开发

调试技巧

1. VS Code 调试配置

创建 .vscode/launch.json 文件:
.vscode/launch.json

2. 日志调试

使用内置的日志系统进行调试:

3. 数据库调试

常用开发命令

项目管理

构建和部署

数据库操作

常见问题

错误信息: Error: listen EADDRINUSE :::3000解决方案:
可能原因: 数据库文件权限或路径问题 解决方案: bash # 检查数据库文件 ls -la data/ # 重新初始化数据库 rm data/dev.db npx prisma migrate dev
解决方案:

进阶主题

架构设计

了解 MCPHub 的整体架构和设计模式

API 开发

学习如何开发和设计 RESTful API

性能优化

掌握性能分析和优化技巧

部署指南

了解生产环境部署的最佳实践