Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Hyrax-Valkyrization MVP

The goal was to have a functional MVP (minimal viable product) prior to this Community Effort.  The MVP for Hyrax using a postgres Valkyrie adapter is defined as: CRUD (i.e. create, read, update, delete) operations for the major components (i.e. admin sets, collections, works, file sets, files) can be successfully accomplished through the UI.  This includes additional functionality that is required to load the forms that support these operations.

The status of the MVP organized by major component is described in Issues #5326.  Any incomplete functionality for the MVP has the highest priority.

What to work on?

The Project Board lists issues related to the Valkyrization effort and includes columns:

  • Ready - issues that are ready to be worked on (no known blockers) and are not already assigned to a developer

  • In Progress - issues currently being worked on - when you move an issue to this column, assign it to yourself and any other developers working on it with you

  • Ready for Review - there is a PR that fixes the issue, tests are green (passing), and it is ready for review

  • DONE - completed issues

There are two additional columns that are used by organizers.

  • Back Log - issues with known blockers OR issues that are older and needing review 

  • Archived - issues closed prior to this community effort

NOTE: You can also see issues related to this effort using the Valkyrization label on the GitHub Issues page for Hyrax

Testing Github Issues

Demo/testing site running the current version of Hyrax with a Valkyrie (Postgres) back end: https://nurax-pg.curationexperts.com/

Nurax-pg feature testing spreadsheet - Identifies feature tests and where things are breaking or stop working currently with Valkyrized Hyrax

Getting Valkyrized Hyrax up and running locally using Docker

[August 31, 2022: The following isn't merged into the main branch yet on Github but should be by community sprint start time to allow local building and running of a Valkyrized Hyrax-based application using Postgres via Docker.]

First, make sure you have installed Docker. Then clone the Hyrax repository.

Within your cloned repository (the hyrax directory) is a .koppie directory that contains a test and development application called Koppie. This is similar to Dassie, but with no Fedora server loaded.

Starting Koppie from the hyrax directory using docker-compose:

  1. Make sure Dassie is not running: docker-compose down

    1. Note if you have Hyrax running locally from previous builds, you might need to clear out old volumes (which will wipe out local data):

docker-compose -f docker-compose-koppie.yml down -v

  1. Build docker images for Koppie: docker-compose -f docker-compose-koppie.yml build

  2. Start Koppie: docker-compose -f docker-compose-koppie.yml up

  3. Load localhost:3000 in a browser.

Reference Documentation

References for Hyrax Development:

References for Understanding Hyrax & Valkyrie Code:


  • No labels