/mirador

An open-source, web-based 'multi-up' viewer that supports zoom-pan-rotate functionality, ability to display/compare simple images, and images with annotations.

Primary LanguageJavaScriptOtherNOASSERTION

Build Status Stories in Ready

Mirador

mirador banner Mirador is a multi-repository, configurable, extensible, and easy-to-integrate viewer and annotation creation and comparison environment for IIIF resources, ranging from deep-zooming artwork, to complex manuscript objects. It provides a tiling windowed environment for comparing multiple image-based resources, synchronised structural and visual navigation of content using openSeadragon, Open Annotation compliant annotation creation and viewing on deep-zoomable canvases, metadata display, bookreading, and bookmarking.

See a Demo

Getting Started

Run in Development

Mirador uses Node.js and a build system to assemble, test, and manage the development resources. If you have never used these tools before, you may need to install them.

  1. Install Node.js
  2. Install the Grunt command line runner i.e. npm install -g grunt-cli
  3. Clone the Mirador repository
  4. Change into the Mirador directory
  5. Install all dependencies with npm install. Run npm start.

Run Tests

npm test

For more information, see the Docs, submit an issue, or ask on Slack.

Project Diagnostics

Coverage Status