Getting Started
Prerequisites
Node.js, pnpm, a PostgreSQL database (Neon recommended), a Stripe account, and at least one transactional email provider (Resend, Scaleway TEM, or AWS SES).
Quick install
- Clone the repository and run
pnpm install. - Copy the environment template (
config/env/env.local.exemple) to.env.local. - Run
pnpm db:pushto sync the schema, thenpnpm db:seedto load reference data. - Run
pnpm devand openhttp://localhost:3000.
Environment variables
Database — DATABASE_URL (pooled connection, used by Server Actions and API routes), PGPASSWORD/PGUSER for direct connections and migrations.
Auth — NEXTAUTH_SECRET (32+ characters; also used to encrypt API keys at rest), NEXTAUTH_URL.
App URL — NEXT_PUBLIC_APP_URL.
AI agents — NEOSAAS_MCP_TOKEN, required for non-interactive agent access to the MCP endpoint.
Email — configure at least one provider: Resend (RESEND_API_KEY), Scaleway TEM, or AWS SES.
Stripe and OAuth do not require environment variables. Both are configured from the admin panel and stored encrypted in the database — no redeploy needed to rotate a key or enable a provider.
Default admin account
Demo/preview environments seed admin@neosaas.tech with a default password. Change it immediately after first login — this account is never seeded with a known password in production.
Verifying your install
pnpm dev starts without errors, the homepage loads, admin login works, the admin panel is reachable, and pnpm db:studio opens a working database browser.
Staying up to date
Every deployment can pull the latest published release and roll it out from its own admin panel (Settings → Updates → Apply update) — no manual git work required. Versioning is fully automated via semantic-release on Conventional Commits.