快速开始

已与启动模板提交 7d452a6 同步。

环境要求

• Node.js >=20.19.0 <23
• pnpm 10.22.0
• Docker Compose，用于默认的 PostgreSQL 与 Redis

本地启动

git clone https://github.com/PansaLegrand/sushi-saas-template.git
cd sushi-saas-template
pnpm install
pnpm setup
pnpm dev

pnpm setup 可重复执行：仅在 .env 不存在时创建它，启动 PostgreSQL 与 Redis，创建相互隔离的开发/测试数据库，并执行已提交的迁移；它不会覆盖现有 .env。

访问 http://localhost:3000。另运行 pnpm dev:admin，可在 http://localhost:3001 打开独立部署的管理端。

验证

curl http://localhost:3000/api/health
curl http://localhost:3000/api/ready
pnpm lint
pnpm test:run
pnpm build

/api/health 只检查进程存活；/api/ready 会检查配置、数据库连接与迁移、Redis 和任务队列。

配置地图

生成的 .env 含安全的本地默认值。生产环境必须配置公开 URL、BETTER_AUTH_SECRET、PostgreSQL、Redis 与可信客户端 IP 来源、CRON_SECRET 和 Turnstile。Stripe、Resend、Slack 与 S3 兼容存储只在启用对应功能时需要。

默认提供英语、中文、西班牙语、法语和日语，可用 NEXT_PUBLIC_LOCALES 控制。公开文档位于独立仓库，通过 NEXT_PUBLIC_DOCS_URL 连接。

接下来阅读架构与错误契约，再配置数据库与身份验证。