Setup MacOS

This document shows the steps for setting up the development environment for a new macOS Catalina (version 10.15) instance. An overview of the contents is shown below:

package manager;
python environment;
ruby environment;
docker;
yadm.

Package manager

HomeBrew is installed manage the software on the system. This can be setup as follows:

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

# Check HomeBrew is installed correctly
# and resolve any issues.
brew doctor

You may be required to install XCode tools. Please follows the instructions shown by HomeBrew.

Python environment

pyenv is used to install different versions of python the system, while keeping the system python clean. Additionally, pipenv is used to handle project dependencies.

brew update && brew install pyenv && brew install pipenv

Open .zshrc and add the following to the top of the file:

zmodload zsh/zprof                                                          
# For loading compdef function
autoload -Uz compinit
compinit

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

eval "$(pyenv init -)"
eval "$(pipenv --completion)"

Finally, install a python version.

pyenv install 3.8.2

Ruby environment

rbenv is installed to manage ruby versions, while keeping the system ruby clean.

brew install rbenv

rbenv init

Open .zshrc and add the following to the top of the file:

# To link Rubies to Homebrew's OpenSSL 1.1
export RUBY_CONFIGURE_OPTS="--with-openssl-dir=$(brew --prefix [email protected])"
eval "$(rbenv init -)"

Check that rbenv has been installed correctly using the following script and resolve any issues:

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

Finally, install a ruby version.

rbenv install 2.7.1

Docker

To install the Docker Engine and Docker Compose, use the cask command provided by HomeBrew, as follows:

brew cask install docker

yadm

To manager any dotfiles, install yadm as follows:

brew install yadm

yadm clone <remote repository url>