Getting started
Generate, configure, and run your first Nextron application.
Before you begin
You need Node.js 20 or newer and one supported package manager: pnpm, npm, Yarn, or Bun. For database-backed modules, have a connection string ready or choose a local PostgreSQL setup.
1. Start the generator
Run the interactive CLI from the directory that should contain your project:
npx @edwinfom/nextron@latest create my-appIf you omit my-app, Nextron asks for a project name. Names may contain lowercase letters, numbers, hyphens, and underscores.
2. Choose a compatible stack
The prompts are applied in this order:
| Decision | Available choices | What it controls |
|---|---|---|
| ORM | Drizzle, Prisma, None | Database client and schema workflow |
| Database | PostgreSQL, SQLite, MySQL, None | Connection format and generated configuration |
| PostgreSQL provider | Neon, Supabase, Local | Driver and connection strategy |
| Authentication | Better Auth, Clerk, NextAuth, None | Session APIs, routes, and middleware |
| Additional modules | tRPC, AI, Stripe, Polar, Inngest, Dashboard | Optional feature packages and source files |
| Package manager | pnpm, npm, Yarn, Bun | Install command and generated instructions |
The Dashboard option requires authentication and is hidden when authentication is set to None.
3. Review before generation
Nextron prints a summary before writing the application. Confirm the ORM, database, authentication provider, modules, and package manager match your intended deployment.
Choose whether to install dependencies immediately. Skipping installation is useful for inspecting the generated files first.
4. Configure the environment
Enter the generated directory and create a local environment file:
cd my-app
cp .env.example .env.localFill every variable marked as required. The generated src/env.ts validates the exact variables needed by your selected modules when the application starts.
5. Prepare the database
For Drizzle projects, apply the generated schema:
pnpm db:pushFor Prisma projects, generate the client and push the schema:
pnpm prisma generate
pnpm prisma db pushReplace pnpm with your selected package manager.
6. Start development
pnpm devOpen http://localhost:3000. If startup fails, read the environment validation message first—it lists missing or invalid variables by name.
Verify the result
A successful project contains nextron.config.ts, .env.example, AGENTS.md, and a src/modules directory for the selected features. Continue with Project structure to understand how the generated code fits together.