gpii-universal/gpii/node_modules/deviceReporter/README.md

Cross platform, core components of the GPII personalization infrastructure.

# Device Reporter

A server app built to be deployed with node.js server that returns device information as well as the list of installed solutions.

## Device Reporter API

The app currently supports the following url:

    {urlToDeviceReporterServer}/device // GET ONLY

## Dependencies

[infusion](https://github.com/fluid-project/infusion) framework.

## Installation

Run the following command in your newly checked out universal repository. This
will pull all dependencies that are required by universal.

    npm install

## Run

To run device reporter app simply type:

    [NODE_ENV={environment}] node node_modules/kettle/lib/init.js path/to/deviceReporter/configs/folder

- Default environment is development.
- Path to configs folder can be absolute or relative to the current user directory.

For example:

    node node_modules/kettle/lib/init.js gpii/node_modules/deviceReporter/configs/
    node node_modules/kettle/lib/init.js /Users/{userName}/universal/gpii/node_modules/deviceReporter/configs/
    NODE_ENV=production node node_modules/kettle/lib/init.js gpii/node_modules/deviceReporter/configs/