The Universal Viewer is an open source project to enable cultural heritage institutions to present their digital artefacts in an IIIF-compliant and highly customisable user interface.
Features:
- OpenSeadragon image zooming using the IIIF image API.
- YouTube-style embedding with deep links to specific pages/zoom regions.
- Themable, fork the UV theme on github to create your own.
- Highly configurable and extensible.
- Supports "IxIF" out of the box, allowing audio, video, and pdf viewing experiences.
- Supports search and autocomplete service integration with overlayed search results.
- Internationalised UI using transifex.com (currently supports English and Welsh. Volunteers for more translations gratefully accepted!)
See the GitHub releases page.
Please see the wiki for instructions on how to customise the viewer for your own projects.
All command-line operations for building the UV are scripted using Grunt which is based on Node.js. To get set up:
-
Install Node.js, if you haven't already
-
Install the grunt command line interface (if you haven't already); on the command line, run:
npm install -g grunt-cli
-
Install bower (if you haven't already)
npm install -g bower
-
Clone the
universalviewer
repository and sub modules:git clone git@github.com:UniversalViewer/universalviewer.git --recursive
-
On the command line, go in to the
universalviewer
folder -
Run
npm install
-
Then run
bower install
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 source maps to aid in debugging.
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 and are copied to examples/uv-[build]
.
If you want to create a zip file for distribution (this will appear in the dist
folder), use:
grunt dist
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.
To view the examples run:
grunt serve
The Universal Viewer is released under the MIT license.