Getting Started
NuxtBase is a production-ready Nuxt 4 SaaS starter kit. It ships with authentication, billing, organizations, admin tooling, AI chat, file uploads, and i18n — all wired together and ready to customize.
This chapter walks you through the minimum steps to get NuxtBase running locally.
Reading Order
Section titled “Reading Order” Installation System requirements, clone the repo, install dependencies.
Quick Start Configure .env, run migrations, and start the app.
Local Development Dev server, email preview, Stripe CLI, and daily workflow.
What You’ll Need
Section titled “What You’ll Need”Before you start, make sure you have access to:
- The private GitHub repository (invite sent after purchase)
- A PostgreSQL database (local or remote)
- Node.js ≥ 22.12.0 and one package manager: pnpm 10+, npm, or yarn
Optional but recommended for full functionality:
- A Stripe test account (for billing)
- A Resend account or local Mailpit (for emails)
- An OpenAI or OpenRouter API key (for AI chat)
Tech Stack
Section titled “Tech Stack”| Layer | Technology |
|---|---|
| Framework | Nuxt 4 / Vue 3 |
| Styling | Tailwind CSS v4 + Nuxt UI v4 |
| Database | PostgreSQL + Drizzle ORM |
| Auth | Better Auth (email, OAuth, 2FA, Passkey) |
| Payments | Stripe (subscriptions) |
| Resend / SMTP / Preview | |
| AI | Vercel AI SDK (OpenAI / OpenRouter) |
| Storage | Local / S3 / Cloudflare R2 |
| Validation | Zod |
| i18n | @nuxtjs/i18n (English + Chinese) |
| Testing | Vitest + Playwright |