Quick Start
Run the Sushi SaaS web and admin apps locally with the supported Node, pnpm, PostgreSQL, and Redis setup.
Synced with starter commit
7d452a6.
Requirements
- Node.js
>=20.19.0 <23 - pnpm
10.22.0 - Docker with Compose for the default PostgreSQL and Redis services
Start Locally
git clone https://github.com/PansaLegrand/sushi-saas-template.git
cd sushi-saas-template
pnpm install
pnpm setup
pnpm devpnpm setup is idempotent: it creates .env only when absent, starts PostgreSQL and Redis, creates isolated development and test databases, and applies the committed migrations. It never overwrites an existing .env.
Open http://localhost:3000. Start the independently deployed admin app with pnpm dev:admin, then open http://localhost:3001.
Verify the Stack
curl http://localhost:3000/api/health
curl http://localhost:3000/api/ready
pnpm lint
pnpm test:run
pnpm build/api/health is a cheap liveness check. /api/ready verifies configuration, database connectivity and migrations, Redis, and queue state.
Configuration Map
The generated .env contains safe local defaults. Before production, configure the public URLs, BETTER_AUTH_SECRET, PostgreSQL, Redis and a trusted client-IP source, CRON_SECRET, and Turnstile. Stripe, Resend, Slack, and S3-compatible storage are required only for the features you enable.
Five locales ship by default: English, Chinese, Spanish, French, and Japanese. Control the enabled set with NEXT_PUBLIC_LOCALES. Public guides live in this detached documentation repository; point the app to them with NEXT_PUBLIC_DOCS_URL.
Next: read Architecture and Error Contracts, then configure the Database and Authentication.