Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 1.2 KB

README.md

File metadata and controls

30 lines (23 loc) · 1.2 KB

Welcome to Engine Hosted APIs

Install

  1. Install latest Node.js
  2. Install latest MongoDB
  3. Ensure Mongo is running: $ mongo (Ctrl+C to quit)
  4. Install grunt comand line app $ sudo npm install -g grunt-cli
  5. Add the following to /etc/hosts:
# To allow development of OAuth stuff locally.
127.0.0.1       local.apinetwork.co

Run

  1. $ npm install
  2. $ grunt
  3. $ node server
  4. Access http://local.apinetwork.co:3000

Developing App (front end)

  1. Start Hosted APIs app (see Run)
  2. Start watch command $ grunt watch (required to be running continually during front end development)
  3. app folder is compiled to dist, which is also the web server root. Accessing http://local.apinetwork.co:3000 reaches dist/index.html.
  4. Install LiveReload Chrome extension to take advatage of automatic brower refreshing while editing .html and .less files (optional)
  5. Before committing any front end code, run $ grunt jshint and solve Javascript syntax issues, then $ grunt jscs and solve any style issues.

IMPORTANT: dist and temp are transient folders and will be erased.