Getting Started

Prerequisites

• Install Ruby
• Install Sass with gem install sass (after installing Ruby)
• Install Node.js
• Install Gulp with npm install -g gulp (after installing Node.js)
• Install a development environment such as Atom or Sublime Text
• Install Google Chrome for running the project. Please note, this is a requirement for the build tools to auto-launch the browser.
• Open the OneNote document and download authentication.json contained in Files >> Config and place in arewegood-web/config. This file is not tracked by git so it will not show up in the repository. This means if you are having an issue, check the document and the associated changelog to make sure everything is up to date. If you make a change, make sure to upload the new version and add your changes to the changelog.
• Add the following lines to your hosts file (for help, see here)
  127.0.0.1 arewegood.local
127.0.0.1 api.arewegood.local

Running the Project

• After cloning the repository for the first time, run (sudo) npm install and from the project directory
• gulp to build an optimized, production-ready version to the .build directory
• gulp watch to build the project, start and preview the build, and watch for changes