Get started with Bolt locally

Install

This is a walk through of the required steps to get Bolt installed and running locally.

Install Oh My Zsh (⚠️ this is needed for step 10)

sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"

Install Brew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Install Yarn
```
brew install yarn
```
- In case of "/usr/local/Cellar is not writable." error, run this line
```
sudo shown -R $(whoami) /usr/local/Cellar
```
Install XCode (the app can be found in the Mac App Store), and open it after, make sure you address any permission prompts
Install Composer
```
brew install composer
```
Install Git
```
brew install git
```

Install NVM (see latest info if the following doesn't work)

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

Restart the Terminal with the command (⚠️ this only applies if you did step 2 and using Z Shell, otherwise reference the link in the last step)
```
source ~/.zshrc
```
Install Node
```
nvm install 14.18.1
```
Set 14.18.1 as default node version
```
nvm alias default 14.18.1
```

In Finder, decide where you want to store code and create a folder
Restart Terminal and cd into the folder to clone the Bolt repository, for example
```
cd Users/yourname/sites
```

Clone the Bolt repository

git clone https://github.com/boltdesignsystem/bolt

Alternatively, use the Github Desktop app to do the last 2 steps if you are not familiar with command lines in Terminal
Move into the Bolt repo folder
```
cd Users/yourname/sites/bolt
```
Set up Bolt
```
yarn setup
```
- If icon SVGs or Pattern Lab UI files have changed since last time you ran Bolt, you will have to build as well
```
yarn build
```
Run Bolt
```
yarn start
```
- This will open a local instance of Bolt in your browser (eg. localhost:4000)
If needed, create a new branch before running yarn setup
- Refer to the Git Naming Convention for more information referring to our branch strategy

If yarn setup fails the first time you run it, check to see if you have PHP 7.

Most likely you will have the following error due to PHP 7.4 being not supported

Error: [email protected] has been disabled because it is a versioned formula!

If you do get this error run the following commands

brew tap shivammathur/php
brew install shivammathur/php/[email protected]
brew link [email protected]

Add the following line to the bottom of the .zshrc file

export PATH="/usr/local/opt/[email protected]/bin:$PATH"