Tulip Logo IconTulip
Quick Start

Create a new app

Scaffold a Tulip application with create-tulip-app and start it locally.

Use create-tulip-app when you want the fastest path to a working Tulip project.

The scaffolded app includes the expected package imports, app shell wiring, protected admin routes, router setup, database setup, and starter configuration for the selected template.

Create the project

Run the CLI with the default basic template:

pnpm dlx create-tulip-app my-app

Or choose a template explicitly:

pnpm dlx create-tulip-app my-app --template basic
pnpm dlx create-tulip-app my-app --template code
pnpm dlx create-tulip-app my-app --template spark

Template choices

TemplateUse when
basicYou want the smallest maintained Tulip app foundation.
codeYou want a broader example app with real feature modules to study.
sparkYou want a richer business app starter with more package wiring included.

Start with basic unless you specifically want to study a larger example.

Install and run

Move into the generated app, install dependencies, and start the dev server:

cd my-app
pnpm install
pnpm dev

The CLI prints the same next steps after it copies the template.

Expected project shape

Your generated app should include the main areas Tulip uses:

src/app
  layout.tsx
  admin/
  auth/
  api/
src/lib/config
src/server

The root layout wires the Tulip providers. The admin layout wires the protected admin shell. The server folder owns auth, database, and router setup.

Next step

On this page