Skip to content
This repository has been archived by the owner on Dec 7, 2021. It is now read-only.

Latest commit

 

History

History
56 lines (38 loc) · 1.52 KB

README.md

File metadata and controls

56 lines (38 loc) · 1.52 KB
Raw

Please note that, this GitHub repository is no longer supported by Avalon Media System

This has been replaced by a new component library at: https://github.com/samvera-labs/iiif-react-media-player.

Avalon IIIF-AV player

Build Status JavaScript Style Guide

This is a React JavaScript application that displays a player and structured navigation when given a IIIF-AV JSON manifest (spec 3.0).

Demo Page:

Developing

Navigate to project root directory and run the following commands. A webpack dev server (with live re-loading) will start at: http://localhost:3334/

yarn install
yarn start

Building

To build the bundle:

yarn build

Running tests:

To run the project's Jest unit tests:

yarn test

Travis Runs...

To use on a page:

 <html>
   <head>
     <title>Avalon IIIF Player Example</title>
   </head>
   <body>
     <div id="avln-iiif-player-root" class="avln-iiif-player" data-manifest-url="http://yourmanifest.com"></div>
     <script src="[INCLUDE /build/static/js/your-compiled-js-file-here.js]"></script>
   </body>
 </html>

The data-manifest-url attribute should link to a publicly accessible IIIF-AV manifest.