installation.md

Installation

How to setup the project locally

Install system dependencies

• Ruby and Bundler - follow this gist.
• Install Node.js - follow this gist.

Install project packages

Setup a hook to build before pushing.

$ make hooks

Install local packages - NPM packages in node_modules and gems in vendor.

$ make install

Configure

1. Make sure you generated a token as per the Token doc.
2. Create an dotenv file from the template.

   $ cp .env.template .env

3. Open the .env file and add your secret token value and save the file.

The result will be something like:

• .env

  GITHUB_TOKEN=abcedf123

This project has been set up to ignore this file, to prevent it being accidentally committed and shared publicly.