create-next-mui
The fastest way to scaffold Next.js + Material UI applications.
Skip repetitive setup and start building with a production-ready foundation in seconds.
[](https://www.npmjs.com/package/create-next-mui)
[](https://www.npmjs.com/package/create-next-mui)
[](https://nextjs.org/)
[](https://mui.com/)
[](LICENSE)
---
---
## β¨ Why create-next-mui?
Starting every new **Next.js + Material UI** project often means repeating the same setup:
- Install Material UI
- Configure Theme Provider
- Set up Emotion
- Configure ESLint
- Organize folders
- Install common libraries
**create-next-mui** automates all of that.
Generate a clean, scalable, production-ready project so you can focus on building your applicationβnot configuring it.
---
# π Features
- β‘ Next.js App Router
- π¨ Material UI v9
- π¦ TypeScript & JavaScript templates
- π§Ή ESLint Flat Config
- π Scalable project structure
- 𧩠Plugin system
- π Zero global installation
- π Production-ready setup
---
# β‘ Quick Start
Create a new project.
```bash
npx create-next-mui my-app
```
or
```bash
npm init next-mui
```
Then start developing.
```bash
cd my-app
npm install
npm run dev
```
---
# π― Interactive Setup
Run the CLI without a project name.
```bash
npx create-next-mui
```
The CLI will guide you through each step interactively.
Current options include:
### Project Name
Choose your application name.
### Language
- TypeScript (Recommended)
- JavaScript
### Optional Features
- Zustand
- React Query (TanStack Query)
---
# β‘ Non-Interactive Mode
Perfect for automation, CI/CD pipelines, or quickly generating projects.
```bash
npx create-next-mui my-app --yes
```
or
```bash
npx create-next-mui my-app -y
```
This automatically:
- Uses the provided project name
- Selects the TypeScript template
- Skips all prompts
- Generates the project immediately
---
# 𧩠Plugin System
One of the biggest advantages of **create-next-mui** is its plugin system.
Instead of generating dozens of templates, install only the features you need.
## Install Zustand
```bash
npx create-next-mui add zustand
```
## Install React Query
```bash
npx create-next-mui add react-query
```
Plugins integrate directly into your existing project with the recommended configuration.
More plugins are planned.
---
# π¦ Available Templates
## TypeScript
Recommended for most projects.
Includes:
- TypeScript
- Strict typing
- Material UI theme typings
- ESLint Flat Config
---
## JavaScript
Perfect if you prefer JavaScript.
Includes:
- Modern JavaScript
- Material UI
- ESLint Flat Config
---
# π Generated Project Structure
```text
my-app/
βββ src/
β βββ app/
β βββ components/
β βββ theme/
β βββ ...
βββ eslint.config.mjs
βββ next.config.js
βββ package.json
βββ README.md
```
The generated structure is intentionally simple, scalable, and easy to maintain.
---
# π What's Included?
Every generated project comes preconfigured with:
| Feature | Description |
| ---------------------------- | --------------------------------- |
| Next.js App Router | Latest routing architecture |
| Material UI | Ready-to-use MUI setup |
| Theme Provider | Already configured |
| Emotion | Integrated automatically |
| ESLint Flat Config | Modern linting configuration |
| eslint-plugin-perfectionist | Organized imports & sorting |
| eslint-plugin-unused-imports | Cleaner codebase |
| Production Structure | Organized folders for scalability |
Development artifacts like `.next`, `node_modules`, and build caches are excluded from generated projects.
---
# π₯ CLI Reference
| Command | Description |
| ---------------------------- | ---------------------------- |
| `npx create-next-mui` | Interactive project creation |
| `npx create-next-mui my-app` | Create a new project |
| `npm init next-mui` | Alternative project creation |
| `--yes` | Skip prompts |
| `-y` | Short form of `--yes` |
| `add zustand` | Install Zustand plugin |
| `add react-query` | Install React Query plugin |
---
# π£ Roadmap
Current progress.
- β
JavaScript template
- β
TypeScript template
- β
Zustand plugin
- β
React Query plugin
Planned improvements.
- β³ Redux Toolkit plugin
- β³ Authentication plugins
- β³ Testing plugins
- β³ More official plugins
- β³ Additional starter templates
---
# π€ Contributing
Contributions are always welcome.
Whether you'd like to:
- Report bugs
- Suggest new features
- Improve documentation
- Submit pull requests
Feel free to open an issue or create a PR.
Every contribution helps make **create-next-mui** better.
---
# π Learn More
Read the development journey and release articles.
- π [Introducing create-next-mui v0.1.0](https://dev.to/thatonevikash/stop-manual-boilerplate-scaffolding-nextjs-with-mui-1l60)
- π€© [create-next-mui v0.2.0 β Plugin Support](https://dev.to/thatonevikash/create-next-mui-v020-is-here-now-with-plugin-support-4l70)
---
# β Support the Project
If **create-next-mui** helps you build projects faster, consider supporting it.
- β Star the repository
- π Report issues
- π‘ Suggest new ideas
- π€ Contribute to the project
- β€οΈ Share it with other developers
Your support helps the project grow.
---
# π License
This project is licensed under the **MIT License**.