mui / mui/material-ui

Create CLI npx create-mui-app

Open
#39,588 7 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

scope: all components type: new feature waiting for 👍
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

Summary 💡

Today, to create a new project, you have to go with one of those:

  1. start from our example folder in GitHub
  2. follow a step-by-step flow (well not just yet, but a WIP #40062)

There is a space to create a CLI specific to MUI (the whole suite of products) that

  • A. would allow developers to quickly pick the stack they want:

    • TypeScript vs. JavaScript
    • Next.js vs. Vite
    • which abstraction level do you want, Base UI (you own the styles) vs. Material UI (you don't own the styles).
    • which theme do you want, Material Design or Joy Design
    • do you want Tailwind CSS, or raw CSS or MUI System
    • do you want Toolpad?
  • B. would allow to easily import a template/block to an existing project.

Examples 🌈
  • Next.js npx create-next-app@latest
Screenshot 2023-10-24 at 12 51 11
  • Vite npm create vite@latest
Screenshot 2023-10-24 at 12 50 48
Motivation 🔦

Achieving this with examples would lead to an explosion of possible combinations, it would be a LOT more examples to maintain.

Related

#39587, #41173

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the related issues #39587 and #41173, then compare the project-creation flows from create-next-app and Vite mentioned in the issue. Define the CLI scope and acceptance criteria for selecting TypeScript or JavaScript, the framework, MUI abstraction and theme, styling approach, Toolpad, and importing templates or blocks.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nextjs, react, tailwindcss, typescript, vite
Domain
cli, developer-experience, frontend, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.