MacOS Setup - Getting Started

Table of Contents generated with DocToc

• Install Homebrew
• Run Getting Started Scripts
• Setup Git
• Setup NVM
• Setup Node.js
• Setup Rbenv
• Setup Email
• Setup VSCode
  • Recommended Extensions
  • Extensions
• Browser Extensions
• Database Management
  • Datagrip
  • Postico
• SSH Keys / Cloning from GitHub
• Team Communication
• Slack & Zoom Screen Recording
• Setup Zoxide
• Doctoc
  • Usage Examples

Install Homebrew

Install Homebrew:

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

The ./getting-started.sh should contain all the applications and cli tools you'll need to get up and running quickly.
If you need anything else you can get it using Homebrew. brew install [formula] (for CLI tools) or brew install --cask [cask] (for applications)
Search Homebrew for formulae and casks

Run Getting Started Scripts

Warning: You'll need Homebrew installed before running these script.

touch ~/getting-started.sh
touch ~/install-apps.sh

Copy and paste the entire contents of the script file from this repo into the newly created files. E.g.

nano ~/getting-started.sh
# paste
# ctrl and x (to exit)
# save when exiting.

Now run the following to make the shell files executable:

sudo chmod -R 755 ~/getting-started.sh
sudo chmod -R 755 ~/install-apps.sh

Now you can run the script:

~/getting-started.sh
~/install-apps.sh

---

Setup Git

Confirm all the defaults

git config --global user.name "Your Name"
git config --global user.email "you@pixielabs.io"

Setup NVM

Installing NVM
Troubleshooting NVM on MacOS

touch ~/.zshrc

The following curl will add some lines to your .zshrc for loading nvm so you need .zshrc to exist first:

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

See Troubleshooting for common issues.

Setup Node.js

Install the newest version of Node.js.

Npm should be installed along with Node.js.

nvm install "lts/*"

Setup Rbenv

Rbenv should have been installed by running the getting-started.sh in the previous section.

Use rbenv to pick a Ruby version for your application and guarantee that your development environment matches production.

rbenv init

Close your Terminal window and open a new one so your changes take effect.
Run the rbenv doctor script to check rbenv is installed correctly:

curl -fsSL https://github.com/rbenv/rbenv-installer/raw/main/bin/rbenv-doctor | bash

Setup Email

• The setup script should have install Front for you. Please set this up.

Setup VSCode

Or skip this section and setup your preferred text editor.

Recommended Extensions

Run the following block to install some recommended VS Code settings.

code --install-extension eamodio.gitlens
code --install-extension wmaurer.change-case
code --install-extension oderwat.indent-rainbow
code --install-extension pranaygp.vscode-css-peek
code --install-extension shardulm94.trailing-spaces
code --install-extension ms-azuretools.vscode-docker
code --install-extension Cardinal90.multi-cursor-case-preserve

If you already have VSCode setup on another laptop and would like to re-use your current extensions
follow these steps on the old laptop:

Extensions

• Open the terminal
• Run the command: code --list-extensions | xargs -L 1 echo code --install-extension
• Copy/save the output (maybe email to yourself) and paste this output in the terminal on your new mac to install the same extensions.

Browser Extensions

We recommend downloading the 1Password (password manager) for chrome.

Database Management

• The setup script should have installed Datagrip & Postico for all your SQL needs.

Datagrip

Postico

SSH Keys / Cloning from GitHub

Learn more about GitHub/SSH keys

1. Generate an SSH key if you don't have one already, or skip to step 3:

ssh-keygen -t ed25519 -C "you@pixielabs.io"

2. The ssh-keygen command will generate a public key ~/.ssh/id_ed25519.pub and a private key ~/.ssh/id_ed25519.

3. The public key should be added to your GitHub account (or other hosting service you are using for your Git repositories) so that you can authenticate with your private key.

cat ~/.ssh/id_ed25519.pub

Copy output to https://github.com/settings/keys

4. Once you have added your public key to your Git hosting service, add the following commands to your ~/.zshrc file to automatically start the ssh-agent and add your private key to it each time you open a new terminal window.

Example addition to your ZSH configuration:

eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519

Team Communication

We use Slack and Zoom to communicate, these should have been install by the script.

Slack & Zoom Screen Recording

You may notice that you cannot share your screen properly on Slack. To fix that:

**System Preferences > Security & Privacy > Privacy > Screen Recording and then clicking the tick box next to slack & zoom (or add them clicking + and searching for the app name) **

You might need to restart Slack & Zoom for the changes to take affect.

Setup Zoxide

Install Zoxide for easier folder traversing.

curl -sS https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | bash

Doctoc

Use doctoc to autogenerate table of contents in markdown files.

npm install -g doctoc

Usage Examples

Default:

doctoc .

Multiple files:

doctoc README.md

doctoc CONTRIBUTING.md LICENSE.md