Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 2.11 KB

README.md

File metadata and controls

40 lines (27 loc) · 2.11 KB
Raw

hyrax-iiif_av

Hyrax plugin for IIIF Presentation 3.0 Audiovisual support

How to use this plugin

  1. Add hyrax-iiif_av to your Gemfile and bundle install

  2. Run generator passing your work type:

rails g hyrax:iiif_av:add_to_work_type MyWorkType

Notice that this generator includes mixins in the work controller and work show presenter.

  1. (Optional) Run avalon player generator:
rails g hyrax:iiif_av:install_avalon_player

This will install webpacker, react-rails, and the avalon player (view partial, react JS, and yarn dependency). This might take a while.

  1. Ingest audiovisual content and see a IIIF viewer render on the work show page.

For a walkthrough of this in a demo application try running through this repository's README: https://github.com/avalonmediasystem/connect2018-workshop

Set up dev / test environment

This project uses engine cart for testing and development purposes. To generate the .internal_test_app directory do the following

export ENGINE_CART_RAILS_OPTIONS="--skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-coffee --skip-puma --skip-test"
bundle exec rake engine_cart:generate

Spec and rubocop can then be run using the rake command.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/samvera-labs/hyrax-iiif_av. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

If you're working on PR for this project, create a feature branch off of main.

This repository follows the Samvera Community Code of Conduct and language recommendations. Please do not create a branch called master for this repository or as part of your pull request; the branch will either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository.