Setup Instructions

Quickstart & Interactive Wizard

Create and run your MERN stack application in less than two minutes.

1. System Prerequisites

Before running the CLI, make sure your local environment meets these requirements:

  • Node.js: v24.16.0 or newer (uses native Node ESM, test runner, and permissions)
  • Package Manager: npm (v10+ recommended)
  • Database: Local MongoDB instance or free MongoDB Atlas cluster connection string

2. Run the Interactive Wizard

Launch the generator in your terminal by passing your desired project directory:

bash
bash
npx create-modern-mern-app@latest my-app

The Clack-powered CLI wizard will guide you through:

? Select language and compiler (TypeScript, React Compiler, or JavaScript)
? Choose styling system (shadcn/ui, Tailwind CSS v4, or clean CSS)
? Include authentication and protected dashboard (Yes/No)
? Select extra integrations (Redux Toolkit, Toastify, Cloudinary, Multer, Nodemailer)
? Install dependencies automatically (Yes/No)

3. Unattended / CI Setup

You can bypass all interactive prompts by passing explicit CLI flags:

Automated TypeScript + shadcn/ui Scaffold
bash
npx create-modern-mern-app@latest portal --yes --language ts --styling shadcn --auth --install
Lightweight JavaScript + CSS Scaffold
bash
npx create-modern-mern-app@latest brochure --yes --language js --styling css --no-auth --no-install

4. Configure Environment & Start Development

Once created, navigate into your directory and start both client and server concurrently:

bash
bash
cd my-app
# Optional: customize server/.env with your MongoDB Atlas URI
npm run dev

Your frontend will be running at http://localhost:3000 and your Express 5 backend API at http://localhost:5000.