MuseMVP 文档
开发

克隆仓库

克隆 MuseMVP、配置远程仓库、安装依赖并在几分钟内启动开发服务器。

系统要求

开始前,请确保以下工具已安装:

Node.js 22.x

必须与 package.jsonengines 字段一致。前往 nodejs.org 下载。

pnpm 10.x

项目包管理器。安装命令:npm i -g pnpm官网

PostgreSQL ≥ 13

支持本地安装(下载),也支持 Neon 等云端无服务器数据库。


克隆与初始化

克隆仓库

前提:已安装 Git

继续操作前,请确保本机已安装 Git。可从 git-scm.com 下载。

推荐使用 SSH 克隆(需提前配置 SSH 密钥):

git clone git@github.com:musemvp/musemvp.git
cd musemvp

若未配置 SSH,也可使用 HTTPS:

git clone https://github.com/musemvp/musemvp.git
cd musemvp

git clone 文档

git-scm.com

配置远程仓库

克隆完成后,建议将原始仓库设为 upstream,便于后续同步官方更新。

移除默认的 origin 远程地址:

git remote rm origin

将官方仓库添加为 upstream

git remote add upstream git@github.com:musemvp/musemvp.git

将你自己的仓库添加为 origin(如有):

git remote add origin <your-repository-url>

验证远程配置:

git remote -v

git remote 文档

git-scm.com

安装依赖

pnpm install

同步上游更新

若你是基于 Fork 开发,需定期从上游仓库拉取最新变更,避免代码偏离主线过远:

git pull upstream main

若存在冲突,请先解决冲突,再提交合并结果:

# 查看冲突文件
git status

# 解决冲突后暂存
git add .

# 完成合并提交
git commit -m "chore: merge upstream changes"

建议频率

建议每日拉取一次最新代码(最好配上一杯咖啡 ☕),保持本地环境与主线同步。


代码更新

拉取最新代码

git pull upstream main

重新安装依赖

依赖发生变化时(如 package.json 有更新),需重新安装:

pnpm install

执行数据库迁移

若数据库 Schema 有变更,需运行迁移命令:

pnpm db:migrate

不要跳过依赖安装

每次拉取代码后,请务必重新运行 pnpm install,确保依赖版本与锁文件一致,避免运行时报错。