primo-explore-rex

A Primo customization package by Royal Danish Library.

Build status:

Target Primo release: August release

The following instructions are intended for Unix-like operating systems.

Installation

Clone or download this repository into the proper place in your Primo Development Environment.
Navigate into the directory where you cloned this repository (the root directory).
Run npm install to install development dependencies.

Building the package

To build the package, navigate into the root directory, and run the following command.

 gulp run --view NUI --browserify

CSS preprocessing

We utilize SASS (with the SCSS syntax) for CSS preprocessing. SASS files are located under css/sass. To start CSS preproccessing, install sass and run the following command in the root directory of the repository.

 sass --watch ./css/sass:./css

Note: Preprocessing is not a requirement for building the package, and would only be needed when the stylesheets are modified. Also, the resulting CSS file should not be modified directly, as the modifications would be overwritten when CSS preprocessing is performed.

Running unit tests

In the root directory, run the following command to perform the unit tests.

npm test

Running E2E tests

Running the E2E tests require Chrome (or Chromium) to be available on the machine. In the root directory, do the following to run the E2E tests.

1- Run the following command to install depencencies for WebDriver.

./node_modules/protractor/bin/webdriver-manager update

2- Run the following command to run E2E tests.

./node_modules/protractor/bin/protractor ./test/e2e/conf.js

License

This software is released under the MIT License.