クイックスタート

スターターのコミット 7d452a6 と同期済みです。

必要環境

• Node.js >=20.19.0 <23
• pnpm 10.22.0
• 標準の PostgreSQL と Redis を動かす Docker Compose

ローカル起動

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 を起動し、開発用・テスト用の独立 DB を作ってコミット済み migration を適用します。既存の .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 は設定、DB 接続と migration、Redis、ジョブキューを確認します。

設定の全体像

生成される .env には安全なローカル既定値があります。本番では公開 URL、BETTER_AUTH_SECRET、PostgreSQL、Redis と信頼できるクライアント IP、CRON_SECRET、Turnstile が必須です。Stripe、Resend、Slack、S3 互換ストレージは有効にする機能に応じて設定します。

英語、中国語、スペイン語、フランス語、日本語を同梱し、NEXT_PUBLIC_LOCALES で制御できます。公開ガイドは分離された本リポジトリにあり、NEXT_PUBLIC_DOCS_URL でアプリからリンクします。

次にアーキテクチャとエラー、データベース、認証を読んでください。