# Installation

### **Installation**

Navigate to your root folder `(ex. materially-react-mui)`

```
c:\>cd materially-react-mui
```

Install Packages by **npm** or **yarn** as per your preferences. Here we are using **`yarn`** the package manager.

```bash
c:\materially-react-mui> yarn
```

{% hint style="warning" %}
If you are using npm, please use **npm i**
{% endhint %}

{% hint style="info" %}
**We would recommend yarn over npm**. Why? see this: [https://www.whitesourcesoftware.com/free-developer-tools/blog/npm-vs-yarn-which-should-you-choose/](https://www.whitesourcesoftware.com/free-developer-tools/blog/npm-vs-yarn-which-should-you-choose/)
{% endhint %}

### Start

After package installation, you can start your app by using **`yarn start`** command

```bash
c:\materially-react-mui> yarn start
```

This will start your local server at **`http://localhost:3000`** Also, your terminal shows the following.

```javascript
Compiled successfully!

You can now view materially-react-mui in the browser.

Local:            http://localhost:3000    
On Your Network:  http://192.168.29.77:3000

Note that the development build is not optimized.
To create a production build, use npm run build.
```

### Build & Deploy

This might be too early to deploy but it is always good to know how to deploy.

To build your app in production use **`yarn build`** command

```javascript
c:\materially-react-mui> yarn build
or
c:\materially-react-mui> npm run build
```

## Troubleshooting

1. This project uses **Yarn (via Corepack)** for dependency management. The required Yarn version is specified in the `package.json` file, and Corepack ensures the correct version is used automatically. There's no need to install Yarn globally.

**If Corepack is not available:**

Corepack is included with Node.js versions 16.10+ by default. If it's not installed or enabled:

1. Ensure you’re using Node.js 16.10 or higher.
2. Enable Corepack by running : `corepack enable`
3. If Corepack is unavailable, update Node.js to a supported version.

After Corepack is enabled, simply run `yarn` commands, and the correct version will be handled for you automatically. For more information about Yarn and Corepack, refer documentation:

1. [https://yarnpkg.com/getting-started/install](https://yarnpkg.com/getting-started/installhttps://yarnpkg.com/corepack)
2. [https://yarnpkg.com/corepack](https://yarnpkg.com/getting-started/installhttps://yarnpkg.com/corepack)
