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

Cross platform, core components of the GPII personalization infrastructure.

# PreferencesServer

A server app built to be deployed with node.js server that saves and returns user preferences using Apache CouchDB as backend.

## Dependencies

[infusion](https://github.com/fluid-project/infusion) framework.
[kettle](https://github.com/fluid-project/kettle) 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 the preferences server type:

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

- 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/preferencesServer/configs/
    node node_modules/kettle/lib/init.js /Users/{userName}/universal/gpii/node_modules/preferencesServer/configs/
    NODE_ENV=gpii.preferencesServer.config.base node node_modules/kettle/lib/init.js gpii/node_modules/preferencesServer/configs/