Skip to content
This repository has been archived by the owner on Nov 22, 2017. It is now read-only.

Latest commit

 

History

History
60 lines (34 loc) · 2.1 KB

README.md

File metadata and controls

60 lines (34 loc) · 2.1 KB
Raw

Universal Viewer

Navigate sequences of images in a zoomable, extensible interface.

example

Google group

Stable Builds

See the GitHub releases page.

Development

Please see the wiki for instructions on how to customise the viewer for your own projects.

First Time Setup

All command-line operations for building the Universal Viewer are scripted using Grunt which is based on Node.js. We are using Node for this project because it provides a powerful cross-platform collection of tools with minimal setup overhead. To get set up:

  1. Install Node.js, if you haven't already
  2. Install the Grunt command line interface (if you haven't already); on the command line, run npm install -g grunt-cli
  3. Clone the 'UniversalViewer' repository: git clone https://github.com/britishlibrary/UniversalViewer
  4. On the command line, go in to the 'UniversalViewer' folder
  5. Run git submodule init
  6. Run git submodule update
  7. Run npm install

Debug Builds

To build the debug version of the viewer, just run (on the command line, in the 'UniversalViewer' folder):

grunt

This will compile the .less files into .css and .ts files into .js with sourcemaps to aid in debugging.

Release Builds

To build the release version of the viewer, just run (on the command line, in the 'UniversalViewer' folder):

grunt build

The built files appear in the 'build' folder.

If you want to build tar and zip files for distribution (they will also appear in the 'build' folder), use:

grunt package

Note that the 'build' folder is masked with .gitignore; it's just for your local use, and won't be checked in to the repository.

Examples

To view the examples run:

grunt serve

License

The Universal Viewer is released under the MIT license. For details, see the file LICENSE.txt.