Quick Start

Install create-next-mui and scaffold your first Next.js + Material UI application in minutes.

Motivation

Get your Next.js + Material UI project up and running in just a few commands.

No global installation is required—everything runs directly with npx or npm init.

Before getting started, make sure you have:

If you don't have Node.js installed, download it from the official website.

Launch the interactive CLI.

npx create-next-mui@latest

npm init next-mui@latest

The CLI will guide you through the setup process, including:

You can also provide the project name directly.

npx create-next-mui@latest my-app

Replace my-app with your preferred project name.

The CLI will continue asking for the remaining configuration options.

If you want to skip the interactive questions and generate a project using the default configuration, use the --yes flag.

npx create-next-mui@latest my-app --yes

npx create-next-mui@latest my-app -y

This automatically:

This mode is ideal for:

After the project has been generated, move into the project directory.

cd my-app

Install dependencies.

npm install

Start the development server.

npm run dev

Open your browser and visit:

http://localhost:3000

You're now ready to start building your application.

The CLI creates a production-ready project with:

Depending on your selections, it can also include official plugins like:

Now that your project is running, continue with the next guides to learn more.

Happy coding! 🚀