/avalon-poc-standalone

Proof of concept IIIF-AV player

Primary LanguageJavaScript

Avalon IIIF-AV player

Build Status JavaScript Style Guide

This is a JavaScript player that displays a player and navagation when given IIIF-AV JSON.

Demo Pages:

Running tests:

To run the project's tests:

./node_modules/karma/bin/karma start

Travis Runs...

standard
karma start --single-run --browsers PhantomJS

Building

To build the bundle:

 ./node_modules/.bin/webpack

To use on a page:

 <html>
   <head>
     <title>Avalon Player Webpack Version</title>
   </head>
   <body>
     <div class="iiif-av-player"></div>
     <div id="data-iiifav-source"  data-iiifav-source="lunchroom_manners_v2.json"></div>
     <script src="bundle.js"></script>
   </body>
 </html>

The data-iiifav-source attribute should link to a publically accesible IIIF-AV manifest.

JSDoc Documentation

Documentation generated from JSDoc comments is published here.

Using with GitHub Pages

You can fork this repository to host your own IIIF Player.

First fork this repository, then edit the HTML pages and upload your own manifests in the dist folder.

Commit the changes and then push.