create-samrose-appDocumentation

Documentation

Everything you need to scaffold a modern Next.js app with create-samrose-app.

Getting Started

create-samrose-app is an opinionated CLI that scaffolds a modern Next.js app with your preferred stack - ORM, database, auth, state management, API layer, and more - all wired together and ready to ship.

No config files to write. No wiring to do. Run the CLI, answer a few prompts, and your production-ready project is ready.

01

Run CLI

One command to start

02

Pick your stack

Interactive prompts

03

Start building

Fully wired project

Installation

Works with all major package managers. Pick whichever you prefer:

โšกnpx
npx create-samrose-app
๐Ÿ“ฆnpm
npm i -g create-samrose-app && create-samrose-app
๐Ÿš€pnpm
pnpm dlx create-samrose-app
๐Ÿงถyarn
yarn dlx create-samrose-app
๐Ÿฐbun
bunx create-samrose-app
โšก

Recommended

Use npx to always run the latest version without a global install.

bash
npx create-samrose-app

Usage

After running the CLI, an interactive prompt guides you through each choice. Every selection is fully configured - no manual setup needed.

bash
? Enter project name โ€บ my-app
? Select ORM โ€บ Prisma
? Select Database โ€บ PostgreSQL
? Select Authentication โ€บ NextAuth
? Add shadcn/ui? โ€บ Yes
? Select State Management โ€บ Zustand
? Select API Layer โ€บ tRPC
? Select Testing โ€บ Vitest
? Add Docker? โ€บ Yes
? Add GitHub Actions? โ€บ Yes
? Add Husky? โ€บ Yes

โœ“ Creating project...
โœ“ Installing dependencies...
โœ“ Done! cd my-app && npm run dev

Use the --yes flag to skip all prompts and scaffold with sensible defaults instantly.

Stack Options

Every combination is supported and correctly configured out of the box.

๐Ÿ—„๏ธ

ORM

Choose your preferred database ORM to match your project needs.

PrismaDrizzleTypeORMMongoose
๐Ÿ›๏ธ

Database

Pick from battle-tested databases for any scale.

PostgreSQLMySQLSQLiteMongoDB
๐Ÿ”

Authentication

Secure your app with the right auth solution.

NextAuthClerkJWT
๐ŸŽจ

UI Components

Optional beautiful component libraries for rapid UI development.

shadcn/ui
๐Ÿ”„

State Management

Manage your application state with proven solutions.

ZustandReduxRecoil
๐Ÿ”Œ

API Layer

Define your API architecture from the start.

tRPCoRPCGraphQLREST
๐Ÿงช

Testing

Ship with confidence using modern testing frameworks.

JestVitest
๐Ÿ› ๏ธ

Extras

Production-ready tooling from day one.

DockerGitHub ActionsHusky

Requirements

๐ŸŸข

Node.js 18+

Minimum supported version

๐Ÿ“ฆ

npm, pnpm, yarn, or bun

Any package manager works

๐Ÿ’ป

macOS, Windows, or Linux

All platforms supported

Development

Want to contribute or run the CLI locally? Clone the repo and follow these steps:

1 - Clone & install

bash
git clone https://github.com/samrosemohammed/create-samrose-app
cd create-samrose-app
npm install

2 - Run in dev mode

bash
npm run dev

3 - Build & dry-run publish

bash
npm run build
npm pack --dry-run

Want to contribute?

PRs and issues are always welcome.

View on GitHub ->