Versions Compared

Old Version 2

changes.mady.by.user Michael Joseph Giarlo

Saved on

compared with

New Version Current

changes.mady.by.user Heather Greer Klein

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

So, you want to help develop the technologies used in the Hydra-in-a-Box project? Great! If you haven't done so before, you may have some questions about how to get started. This FAQ collections questions commonly asked by developers new to the Hydra-in-a-Box project or new to Hydra Samvera community work cycles.

Prerequisites

...

  • Appropriate GitHub repositories (see below)
  • Planning documentation on the Hydra Samvera wiki and Google Docs
  • Hydra Samvera Slack

If you don't yet have accounts for Google Docs, the DuraSpace wiki, or GitHub, you'll want to sign up for each.

...

Hyku (the Hydra-in-a-Box repository application) is built on Hydra Samvera community components. Most of the work that we do in our sprints are on Hyku and Hyrax, though we also touch a number of other Hydra Samvera components when necessary. Hyku is a Rails application based on Hyrax.

Development Tools and Practices

...

There is also an in-progress Hydra Samvera Technical On-Boarding document, which provides details about how the Hydra Samvera community communicates, how we track issues, code guidelines, and the code review process.

...

  1. Hyku is a Hyrax-based application, so you'll need to start out by ensuring you have all the necessary Hyrax pre-requisites installed. Generally speaking, you should also review the Hyrax installation/
  2. Install the Hyku codebase itself (e.g. by cloning https://github.com/projecthydrasamvera-labs/hyku)
  3. Install all gem dependencies: bundle install
  4. Create your database (should be PostgreSQL as noted above): rake db:create
  5. Run all database migrations: rake db:migrate
  6. Start servers (which starts Solr, Fedora, and Rails together): rake hydra:server
    1. Alternatively, if you are doing a lot of development, you may find it easier to start/stop each of these individually by running each of the following in different terminals:
      1. solr_wrapper  (Starts Solr on port 8983)
      2. fcrepo_wrapper (Starts Fedora on port 8984)
      3. rails server (Starts Hyku on Hydra on port 3000)
  7. Ensure you have loaded the Hyrax Workflows and created the default Hyrax Administrative Set. Currently, these are not run automatically, and the default AdminSet is required before you can add Works.
    1. rake hyrax:workflow:load
    2. rake hyrax:default_admin_set:create
  8. Access Hyku by visiting http://localhost:3000/ in a web-browser.
    1. To create an initial administrator account, simply register with a new login/password.

...

Generally speaking, we follow the guidelines / recommendations in Hydra samvera Technical On-Boarding regarding both Code Guidelines and Code Reviews.

...

https://wiki.duraspace.org/display/hydrasamvera/Hydra-in-a-Box+Project+Team

...