Skip to content

Environment Setup

Jump to bottom
paulickj edited this page Jun 4, 2020 · 2 revisions

Ubuntu

These instructions were written originally for an ubuntu 19.10 LTE release.

  1. Set up Ruby with RVM. Follow the instructions located (here)[https://rvm.io/rvm/install]

  2. Set up bundler This step depends on ruby and rvm being installed and working. To double check you can run ruby -v Our projects allow for a version of ruby that's at least 2.5.5 but our developers have used versions at late as 2.6.3 To switch versions of ruby type rvm use x.x.x where x.x.x is the version of ruby to use.

Assuming ruby 2.5.5 or greater, you can now run: gem install bundler

  1. Set up Yarn Follow the instructions located (here)[https://classic.yarnpkg.com/en/docs/install/#debian-stable]

  2. Set up git on your machine (if you don't have it yet). sudo apt install git

  3. Set up your ssh keys. Run ssh-keygen, and follow the steps to create a public/private key pair. In the github web interface, go to your profile > settings > SSH & GPG keys. Click on 'add a new SSH key'. Now you are going to cat the location of your public key, and copy your public key to the textbox in the Github web interface. For example, if my ssh key was located at /home/users/.ssh/id_rsa.pub, I would type cat ~/.ssh/id_rsa.pub, copy the output and copy it into Github.

If you're not sure where your public key went, double-check the output from your earlier ssh-keygen. Give your new key in github a title (like 'hobby-vm-keys' for example, just to tell you which machine is using the key), and save.

Windows

  1. Set up Ruby Download the recommend version of ruby with devkit from here and follow the installer instructions after double clicking on the downloaded installer.

  2. Set up Bundler To double check your ruby installation run ruby -v from git bash.

If you get an error that ruby is not a recognized command ruby you need to add ruby to your PATH. In the windows search field type search for Edit the system environment variables and click on the Environment Variables button. Select the path variable under user variables and click edit and then add an entry to the path of your ruby installation which should be at the root of the C drive. For example if you installed ruby 2.5 the ruby installation path to add should be C:\Ruby25-x64\bin. After your path has been added check your ruby installation again.

After you've confirmed your ruby installation run the command gem install bundler from git bash

  1. Set up Yarn Download the installer from here and run the installer

  2. Set up git Download git from here using the recommended defaults.

  3. Setup your ssh keys Generate a new ssh key using the instructions from here

Add the ssh key to your GitHub account using the instructions from here

Clone this wiki locally