Local Dev Environment Setup

Let’s get you ready to go by getting your local development environment up and running

👋 Welcome! We’re excited for you to get our main site running on your computer!

Inform the DevOps team when you’re attempting this session. You will likely experience last-minute unexpected failures someone on that team will be best equipped to deal with.

Notes Before Onboarding

There are a lot of commands and terms here. Setup can be daunting if you haven’t done it before. It’s not just you! *Please ask for help when these get confusing!***

See also Troubleshooting for common issues.

Bootstrap Your Laptop

Protip: This should be run prior to the onboarding session. It takes ~10-15 minutes with very little user interaction.

Follow the instructions in https://github.com/acme-engineering/bootstrap:

git clone https://github.com/acme-engineering/bootstrap.git cd bootstrap ./bootstrap.sh | tee -a bootstrap.log

With Docker installed, go to Docker Preferences → Resources → and increase RAM to 4GB.

Fedora Local Dev Setup

GitHub

Check with an engineer to make sure you’ve been added to both:

  • Our private Acme Engineering organization, on the Employees team and your team.
  • Our public Acme organization, on the Employees team.

Admins that can make this happen include Jake (@jake), Josh (@josh), Timor (@timor), and engineering managers in general.

Add Your SSH Key to GitHub

Bootstrap should have created the ~/.ssh/id_rsa.pub file; if not, see the GitHub docs.

  1. Login to **GitHub > Settings > SSH and GPG Keys** and select New SSH Key

  2. Copy your public key:

    pbcopy < ~/.ssh/id_rsa.pub
  3. Paste the contents of the public key into the key field and provide a unique title such as “Acme MacBook”.

  4. Select Add SSH Key.

  5. Click the Enable SSO button on the newly added SSH key and authorize Acme-Engineering.

Configure Git

git config --global user.email <your acme email>