本地搭建
以下步骤以仓库根目录为当前工作目录,目标应用为 apps/nextkity。
1. 安装依赖
pnpm install
若遇个别包安装权限 / 损坏依赖问题,优先在终端(非 IDE 沙箱)重试完整 install;排查见后续 Troubleshooting(待补)。
2. 配置环境变量
cd apps/nextkity
cp .env.example .env
至少确认:
| 变量 | 说明 |
|---|---|
DATABASE_URL | 指向你的 Postgres(含 schema 若需要) |
AUTH_SECRET | 足够长的随机串(NextAuth v5) |
AUTH_COOKIE_PREFIX | demo 使用 nextkity,避免与同域其他 app 串 Session |
NEXT_PUBLIC_BASE_URL / AUTH_URL / NEXTAUTH_URL | 本地建议与端口一致,例如 http://localhost:3000 |
.env.example 中可能带有演示站域名(如 https://demo.nextkity.com)。本机开发请改成 localhost,并与 docs/platform/monorepo/local-ports-and-auth-cookies.md 保持一致。
支付、SMTP、OAuth、Turnstile 等可按需再填;本地支付可先开 Mock(见 example 中 MOCK_PAYMENTS 相关注释)。
不要把含真实密钥的 .env 提交进 Git。
3. 数据库:合并 schema、生成客户端、迁移
仍在 apps/nextkity 下(或使用 filter 等价命令):
pnpm db:merge
pnpm db:generate
pnpm db:migrate
约定:
- 使用 migrate 推进结构变更
- 默认不要用
prisma db push作为日常流程(与仓库规则一致)
可选初始化:
pnpm db:seed:init # 超级管理员(读 SUPER_ADMIN_*)
pnpm db:seed:demo # demo 数据(按需)
4. 启动开发服务
回到仓库根:
pnpm dev:nextkity
默认:**http://localhost:3000**(Turbopack)。
等价写法:pnpm --filter nextkity dev。
5. 文档站(可选)
本开发文档真源在 apps/nextkity-saas/content/docs。若只在 saas 进程下看文档站,需启动 saas;若已将文档人工同步到 apps/nextkity/content/docs,则可在 demo 的 /zh/docs 阅读。
二次开发产品功能时,以跑通 pnpm dev:nextkity 为准。
下一步
→ 首次验收