Workspace Setup

Before you begin development, it’s important to configure your workstation properly. This section will give you an overview of what tools are installed and get you bootstrapped.

Table of contents

1. Development Tool list
2. Install Rosetta 2 (Apple Silicon only)
3. Install XCode Command Line Tools
4. Run the setup.sh script
5. Clone the repository
6. Configure AWS CLI
7. Now what?

---

Development Tool list

This is a static list of tools that should be pre-installed to support all Developer Guide. Please understand that the installation of most of these tools is automated, which will be discussed in the next section. This serves as a general overview of what will be installed.

Tool	Version	Required
MacOS	10.15+	Yes
Rosetta 2 (Apple Silicon only)	2	Yes
XCode Command Line Tools	2392	Yes
NodeJS	14.x	Yes
Node Version Manager (NVM)	0.39.1	Yes
Bun	1.1.20	Yes
Direnv	2.31.0	Yes
AWS CLI	2.x	Yes
AWS CLI Sessions Manager Plugin	1.2.312.0	Yes
jq	jq-1.6	Yes
awslogs	1.2.312.0	Optional
Git	2.x	Yes

Install Rosetta 2 (Apple Silicon only)

If you’re on a newer model Mac with an Apple ARM based chip (M1 series), you need to install Rosetta 2.

Follow this Apple Support guide to install Rosetta 2.

Install XCode Command Line Tools

Follow the installation guide.

Run the setup.sh script

Once you reach this step, the remainder of the tools you’ll need can be installed with a simple script.

• Download and save the setup.sh script somewhere accessible on your computer. Your Downloads folder, which is probably your default download location, is fine.
• Open a terminal
• Run the setup.sh script

  sh ~/Downloads/setup.sh
  

  Please note that you may be prompted to input your OS user’s password, as some installation steps require higher priveleges.

After successfully running the setup script, close all open terminals. The script adds PATH modifications to your .zshrc file, and that file will only take affect when starting a new terminal session. To ensure you immediately have the PATH modifications available, it’s easiest to simply close all terminal windows now. You may reopen the terminal at any time afterwards.

Clone the repository

Now that you have all prerequisites installed, it’s time to get the code base. This will require your git repo access request to have been completed.

• Configure your GitHub user with an SSH key, and add it to your ssh-agent. Help can be found here. Using https and personal access tokens, instead of SSH and a key, is possible but discouraged.
• Clone the repository

  git clone git@github.com:Enterprise-CMCS/macpro-mako.git
  

Configure AWS CLI

This step requires that your request for AWS access has been completed. If it hasn’t, you’ll need to wait, then return here.

• Login to the AWS Console.
• Create an AWS Access Key Id and Secret Access Key for your IAM user. Detailed instructions are available.
• Configure the AWS CLI with valid credentials. Background and instructions can be found here. Running aws configure and following the prompts should suffice, though.

Now what?

Nice job! If you’ve successfully stepped through this document, you should be entirely ready to start active development on the macpro-mako project.

If you’ve had errors along the way, that’s OK! We’re here to help. If you’ve successfully joined our Slack channel, feel free to post there. Else, please send an email to mdial@collabralink.com explaining the issue. We will get back to you ASAP.