Objective

This guide is for folks with no prior knowledge or very little familiarity with development. It’s meant to help them set up the Material UI repository locally, install all the basic tools they need, and ultimately be able to make changes to our website and documentation (e.g., adding new blog posts, job ads, etc.).

Required tooling

Open your computer’s Terminal to install the packages below.

  1. Press Command + Space Bar on your Mac keyboard (alternatively, press F4)
  2. Type in “Terminal”
  3. When you see Terminal in the Spotlight search list, click it to open the app.

Node.js

The first thing you need to install on your computer is Node.js. It's a tool that allows a persistent connection from the browser to the server and allows you to run the code locally. Install the "recommended for most users" version from Node's website.

Node Version Manager (NVM)

pnpm

Finally, pnpm is MUI's package manager, so you must install that on your computer and the repo. Paste this command in your Terminal:

npm install --global pnpm

If you then paste pnpm -v in the Terminal, it should return its version.

Troubleshooting

If that’s your first time doing this, at least in macOS, you may get this error:

Error: EACCES: permission denied, mkdir '/usr/local/lib/node_modules/pnpm'

This is because you don’t have permission to install something on your machine globally. Add sudo in front of the install command to force the installation regardless of the current permission setting.

sudo npm install --global pnpm

macOS optional tools