PanaxUI API Node.js

1. Clone Git Repo

$ git clone https://github.com/panaxit/panaxui-nodejs.git
$ cd panaxui-nodejs

2. Install Node.js

In case you haven't, install Node.js in the server:

Supprted LTS versions:

• Linux/OSX: >= v0.12.* (64bit)
• Windows 7: >= v0.10.36 (32bit)

More info: https://github.com/nodejs/LTS

Preffered method: NVM

• Unix: nvm
• Windows: nvmw / nvm-windows

Direct download:

nodejs.org/download

Docker Container / Vagrant VM

Pending

3. Install Modules

NPM Dependencies listed in package.json, to be installed locally:

$ npm install

libxslt extra dependencies:

libxslt depends on libxmljs, a library with native LibXML bindings, which in turn depends on node-gyp for binary compilation (more info), therefore the following software is needed:

• Python
  • Unix: Python v2.7
  • Windows: v2.7.3
• C/C++ Compiler
  • Unix: GCC
  • Windows: Visual Studio C++ 2010 Express

4. Configure config/panax.js

See: Kitchensink config example

5. Run PanaxUI API server

 $ npm run start

or use forever:

$ npm run start:forever

6. Unit / Integration Tests

$ npm test

or test remote:

$ npm run test:remote

7. ESLint (Linter)

$ npm run eslint

8. Commit Changes

$ npm run commit