Timeliner

Timeliner is a reimplementation of Variations Audio Timeliner as a web application, using the IIIF Presentation API 3.0.

Installation

Node 18+ and yarn are required.

yarn install

Development

Start the main application at at http://localhost:5173/ with hot-reload using,

yarn start

Start the documentation site in development mode at http://localhost:3000/ using,

yarn docz:dev

Building

Build the main application,

yarn build

Build the main application and documentation together,

yarn build:all

Preview the production build (main app + docs) at http://localhost:5173/ and docs at http://localhost:5173/docs using,

yarn preview

Testing

yarn test

To test the latest Timeliner code in Avalon follow these steps,

1. Pull the latest code from the main branch in GitHub
2. Run yarn build create a new build from the code
3. Copy contents of /dist/assets/main-**.css and /dist/assets/app-**.css into /app/javascript/iiif-timeliner-styles.css in Avalon
4. Copy contents of /dist/assets/main-**.js and /dist/assets/app-**.js into /app/javascript/iiif-timeliner.js in Avalon
5. Search and remove the import "./main-**.js"; statement in the copied JS content in Avalon

Links

Documentation | User stories | UX Wireframe | Original timeliner | Demo site | Changelog