Public | Automated Build

Last pushed: 2 years ago
Short Description
aharnum universal
Full Description

GPII Universal

Cross platform, core components of the GPII personalization infrastructure. This repository should not be used directly,
but in conjunction with one of the top-level GPII architecture-specific repositories. Documentation for this project is
housed beneath http://wiki.gpii.net/w/Architecture .

Installation

This repository should be installed using one of the top-level GPII architecture-specific repositories -

For development purposes this repository could be cloned directly - however, please ensure that it is housed
in a directory named node_modules otherwise its test cases will not be able to self-resolve.

Whenever you run npm install for this project, you must always follow by issuing the grunt task grunt dedupe-infusion.
The reason for this requirement is explained at http://issues.gpii.net/browse/GPII-492

Usage

To use any of the gpii components or functionality in node.js, use the
following statements to get access to fluid and/or gpii objects.

var fluid = require("universal"),
    gpii = fluid.registerNamespace("gpii");
// Now you will have access to both fluid and gpii namespaces.

Testing

There are currently 2 different sets of tests: the ones that run in the browser
and the ones run in node.js.

Running browser tests:
open {universal}/tests/web/html/all-tests.html in your preferred browser:

Running node-based tests:

node tests/all-tests.js

Deploying with Docker

The Docker Hub Automated Build service is used to automatically build a GPII Universal Docker image. The Docker client can then be used to download updated images and launch containers.

The following command can be used to build an image locally as long as it is run relative to the repository's Dockerfile:

docker build --rm -t gpii/universal:$(git rev-parse --short HEAD) .

That will use the Git repository's current abbreviated commit hash as a Docker tag. If you would like to download the latest public Universal image you can use this command:

docker pull gpii/universal

Or use the following command to download a particular image identified using a Git commit hash:

docker pull gpii/universal:<first seven characters of a git commit hash>

GPII component images can then be built using the Universal image. Here are two examples:

Docker Pull Command
Owner
aharnum
Source Repository