Setting Up Your Dev Environment

Prerequisites:

This should be completed on a Mac or Linux operating system.

Please have installed on your computer:

• Ruby, version 2.3.1
• Yarn
• Git
• Homebrew

If you do not already have Yarn, we suggest installing it via homebrew (See here) as this will also install Node if that is not already installed on your system.

Installation and Getting Started

Clone this repo and cd into it. Then on the command line, run the following:

bundle install

then:

webpack::install

We use Webpack for the front end JS aspects (transpiling, rendering, etc) and rails for the backend aspects.

Sample Data

There is a sample_data.json in the root directory. Please use this to seed your database models.

Starting the local server

Once this repo is installed and while in the repository, on the command line run the following:

rails s

From there, the application can be viewed by typing into the URL bar:

localhost:3000