Inicio rápido
Ejecuta localmente las aplicaciones web y de administración de Sushi SaaS con Node, pnpm, PostgreSQL y Redis compatibles.
Sincronizado con el commit
7d452a6del starter.
Requisitos
- Node.js
>=20.19.0 <23 - pnpm
10.22.0 - Docker Compose para PostgreSQL y Redis predeterminados
Inicio local
git clone https://github.com/PansaLegrand/sushi-saas-template.git
cd sushi-saas-template
pnpm install
pnpm setup
pnpm devpnpm setup es idempotente: solo crea .env si no existe, inicia PostgreSQL y Redis, crea bases separadas de desarrollo y pruebas y aplica las migraciones versionadas. Nunca sobrescribe un .env existente.
Abre http://localhost:3000. Ejecuta pnpm dev:admin para la aplicación administrativa independiente en http://localhost:3001.
Verificación
curl http://localhost:3000/api/health
curl http://localhost:3000/api/ready
pnpm lint
pnpm test:run
pnpm build/api/health comprueba vida; /api/ready valida configuración, base de datos y migraciones, Redis y la cola.
Mapa de configuración
El .env generado tiene valores locales seguros. En producción configura URLs, BETTER_AUTH_SECRET, PostgreSQL, Redis y una fuente fiable de IP, CRON_SECRET y Turnstile. Stripe, Resend, Slack y almacenamiento S3 solo son obligatorios para las funciones activadas.
Se incluyen inglés, chino, español, francés y japonés; controla el conjunto con NEXT_PUBLIC_LOCALES. La documentación pública vive en este repositorio separado y se enlaza con NEXT_PUBLIC_DOCS_URL.
Continúa con Arquitectura y errores, Base de datos y Autenticación.
Páginas y operaciones de la consola de administración
Conoce cada página de administración incluida y las reglas de seguridad para facturación, moderación y escrituras.
Arquitectura y contratos de error
Comprende las capas obligatorias de Sushi SaaS, el flujo de datos del navegador, la autorización y el sistema de errores traducidos sin filtraciones.