快速开始

通过一套引导流程自定义并启动 Web、管理后台、Content Studio、Worker、PostgreSQL、Redis 与本地对象存储。

已根据 starter 提交 2a1a04a 验证。

完成本页后，客户应用、管理控制台、Content Studio、持久 Worker、SaaS 开发/测试数据库、Payload 数据库、Redis 和私有本地 S3 兼容 bucket 会一起运行。

环境要求

Node.js >=20.19.0 <23
pnpm 10.22.0
Docker Compose

第一次引导安装

git clone https://github.com/PansaLegrand/sushi-saas-template.git
cd sushi-saas-template
pnpm install
./scripts/setup.sh development
pnpm dev:doctor
pnpm dev:all

引导流程会打开 pnpm customize，写入缺失的忽略环境配置，启动 PostgreSQL、Redis 与 Garage，创建 sushi_dev、sushi_test、sushi_content 和恢复演练数据库，应用 Drizzle/Payload 迁移，并准备私有 sushi-dev bucket。它可以重复运行且不会覆盖现有环境文件。若想保留中性产品默认值，可用 pnpm setup。

dev:doctor 只读检查工具版本、环境边界和权限、Docker、数据库、Redis、迁移、对象存储、Studio 配置与端口，不打印密钥。

dev:all 启动：

进程	地址
客户应用	`http://localhost:3000`
管理控制台	`http://localhost:3001`
Content Studio	`http://localhost:3002/admin`
持久 Worker	带前缀日志的后台进程

安全演示数据与重置

pnpm dev:seed
pnpm dev:reset -- --dry-run
pnpm dev:reset

Seed 会幂等创建或修复已验证的 .test 账户、个人组织、确定性的 1,000 积分和演示预约。Reset 会拒绝外部服务、预览本地目标、要求明确确认，并只重建本 Compose 项目的数据。

验证完整 starter

curl http://localhost:3000/api/health
curl http://localhost:3000/api/ready
pnpm test:fast
pnpm test:e2e
pnpm build

Playwright 会通过 Better Auth 登录，并验证组织积分、真实 Garage 上传，以及经过 Worker 和签名结果的五积分图像任务。下一步阅读自定义产品、架构与错误契约和测试与 CI。

环境要求

第一次引导安装

安全演示数据与重置

验证完整 starter

本页内容