MuseMVP 文档

快速开始

获取源码、启动本地应用,并使用开发账号完成第一次登录。

完成这篇后,你会得到一个本地可运行、可登录的 MuseMVP 应用。真实支付、OAuth 和存储可以稍后再接,不必首次启动就全部配置完。

开始前准备

  • Git,以及购买后获得源码访问权限的 GitHub 账号。
  • Node.js 22.x 和模板锁定的 pnpm 10.26.2。
  • 正在运行的 Docker Desktop,或已有的 开发用 Postgres 数据库。

启动本应用前,先关闭其他占用 3000 端口的应用。

1. 获取源码

使用已获得仓库权限的 GitHub 账号克隆:

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

已配置 SSH 的话,也可以使用 [email protected]:musemvp/musemvp.git。后续命令均在仓库根目录执行,也就是有 pnpm-workspace.yaml 的目录。

2. 初始化应用

本地开发

先启动 Docker Desktop,再执行:

pnpm muse:init --yes --app web --docker
pnpm db:seed
pnpm dev

初始化会启动仓库自带的本地 Postgres、写入 apps/web/.env.local、生成签名密钥,并执行迁移。seed 会创建用于体验应用的开发账号。

已有开发 Postgres?将初始化命令换成下面这一条,替换为你自己的连接串:

pnpm muse:init --yes --app web --database-url "postgres://USER:PASSWORD@HOST:5432/DATABASE"

之后仍执行 pnpm db:seed 和 pnpm dev。请使用全新的开发库,不要指向已有生产数据库。

3. 打开页面,第一次登录

终端提示服务就绪后,打开 http://localhost:3000。访问 /auth/login,选择密码登录表单,使用任一账号:

账号密码可以体验什么
[email protected]musemvp工作台与个人设置
[email protected]musemvp工作台,以及管理员用户管理

以上使用未修改的 seed 默认值。如果改过 MUSE_SEED_EMAIL 或 MUSE_SEED_PASSWORD,请使用你配置的邮箱域名和密码。这些账号仅用于开发。

Node 初始化默认使用 MAIL_PROVIDER=console:邮件打印在服务端终端中,不会真正投递。首次体验先用 seed 密码账号;测试真实注册或验证码投递时,再配置 邮件。

确认结果

  • 公开首页能打开,没有服务端报错。
  • 普通账号可以访问 /app 与 /app/settings/general。
  • 管理员账号可以访问 /app/admin/users。
  • 退出后返回公开页面,再访问 /app 会要求登录。

常见问题

遇到什么怎么处理
GitHub 提示仓库不存在确认 GitHub 账号已接受仓库权限,再检查 HTTPS/SSH 凭据
找不到 pnpm执行 npm install -g [email protected],重新打开终端
Docker 初始化失败启动 Docker Desktop,检查其他 Postgres 是否占用 5432
数据库连接被拒绝检查 apps/web/.env.local 中开发库的地址、端口、账号与密码
密码登录失败执行对应 seed 命令,检查 seed 密码;使用密码表单,而不是 OTP
3000 端口被占用关闭另一个应用,或调整端口和对应站点 origin 后再测试登录
缺少生成的内容类型运行 pnpm dev 或 pnpm build,生成 Fumadocs 源

可以运行 pnpm muse:doctor 检查工具链。不要用 --force 排查已有环境:它可能替换已配置的值和签名密钥。

下一步:换成你的产品

继续阅读 品牌与应用设置。按需接入 邮件、支付 和 存储。

将产品保存到自己的私有仓库,以及后续同步模板更新,单独放在 更新已有项目 中。

本页目录