Scaffold with create-nextrush

What you'll have

By the end, a new folder runs with pnpm dev (or your package manager's equivalent):

Prerequisites

Prefer wiring every file yourself first? Start with Installation or the Task API tutorial, then come back here for your second project.

Run it

The scaffolder is the npm package create-nextrush. Your package manager can invoke it several ways:

$ pnpm create nextrush my-api

my-api is the target directory — pass . to scaffold into the current folder, or omit it to be prompted. The flow is built on @clack/prompts.

How it works

Six prompts, every one with a default — press Enter to accept.

Skip the prompts

Every prompt has a matching flag. A fully-specified command never pauses:

pnpm create nextrush my-api --style functional --runtime node --middleware api

pnpm create nextrush my-bun-api --style functional --runtime bun --middleware full

pnpm create nextrush my-deno-api --style class-based --runtime deno --middleware api

-y / --yes accepts every default without specifying each option:

pnpm create nextrush my-api --yes

Scaffold without install or git:

pnpm create nextrush my-api --yes --no-install --no-git

Project styles

Every style shares tsconfig.json, package.json, README.md, .gitignore, and src/env.d.ts for editor hints — then adds its own source layout. Each ships at least one real vitest unit test, not a placeholder.

import { createApp, createRouter, listen } from 'nextrush';
import { cors } from '@nextrush/cors';
import { json } from '@nextrush/body-parser';
import { helmet } from '@nextrush/helmet';
import { healthRouter } from './routes/health.js';

const router = createRouter();
const app = createApp({ router });
const PORT = Number(process.env.PORT) || 8080;

// Middleware
app.use(cors());
app.use(helmet());
app.use(json());

// Routes
router.get('/', (ctx) => {
  ctx.json({ message: 'Welcome to NextRush!' });
});

app.route('/health', healthRouter);

await listen(app, PORT);

import { createApp, createRouter, listen } from 'nextrush';
import { registerControllers } from 'nextrush/class';

const router = createRouter();
const app = createApp({ router });

await registerControllers(app, {
  root: CONTROLLERS_ROOT,
  include: CONTROLLERS_INCLUDE,
  prefix: '/api',
  strict: true,
});

await listen(app, PORT);

import { Controller, Get } from 'nextrush/class';
import { AppService } from '../services/app.service.js';

@Controller('/health')
export class HealthController {
  constructor(private readonly appService: AppService) {}

  @Get()
  check() {
    return this.appService.getHealth();
  }
}

After scaffolding

cd my-api

pnpm dev     # hot-reload dev server
pnpm test    # run the generated unit test(s)
pnpm build   # production build
pnpm start   # run the production build

Verify the server (functional style, default middleware):

curl http://localhost:8080/
# → {"message":"Welcome to NextRush!"}

curl http://localhost:8080/health
# → {"status":"ok","timestamp":"…","uptime":…}

Class-based projects answer on /api/health instead of /health.

Common mistakes

What you learned

• ✓ Invoke the scaffolder with your package manager — pnpm, bun, npm, or yarn
• ✓ Three project styles: Functional (smallest), Class-based (structured), Full (both)
• ✓ Runtime selection changes the adapter import and scripts — Node, Bun, or Deno
• ✓ Middleware presets wire cors, body-parser, helmet (API) + rate-limit, compression, request-id (Full) in production-safe order
• ✓ Every style ships at least one real vitest unit test, not a placeholder

🎉Scaffold completeYour project is generated, dependencies installed, and a real test is passing. Run pnpm dev to start the server.

Next steps