Hydra Repository Rails Engine
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
gemfiles
hydra-access-controls
hydra-core
lib/hydra
spec/test_app_templates
.coveralls.yml
.gitignore
.gitmodules
.mailmap
.travis.yml
.yardopts
CONTRIBUTORS.md
Gemfile
HYDRA_VERSION
LICENSE
README.md
RELEASING_HYDRA_HEAD.md
Rakefile
hydra-head.gemspec

README.md

Hydra-Head

Code: Version Build Status Coverage Status

Docs: Contribution Guidelines Apache 2.0 License

Jump in: Slack Status

What is Hydra-Head?

Hydra-Head is a Ruby-on-Rails gem containing the core code for a web application using the full stack of Samvera building blocks.

Product Owner & Maintenance

hydra-head is a Core Component of the Samvera community. The documentation for what this means can be found here.

Product Owner

cjcolvar

Help

The Samvera community is here to help. Please see our support guide.

See the Github wikis for information targeted to developers: http://github.com/samvera/hydra-head/wiki

See the Duraspace Hydra wikis for information at the architecture level: http://wiki.duraspace.org/display/samvera/

Additionally, new adopters and potential adopters may find the pages here useful: http://samvera.org/

Further questions? Get in touch

Installation/Setup

Installation Prerequisites

See the Installation Prerequisites wiki page.

Ruby 2.1.0+ is required by Hydra-Head release 10+; RVM is strongly suggested.

Install Rails

gem install 'rails' --version '~>5.1.0'

Generate a new rails application:

rails new my_hydra_head
cd my_hydra_head

Install Dependencies

First, add them to the Gemfile of your application. The new rails application you just generated will have generated a Gemfile; add blacklight and hydra-head as below:

  source 'https://rubygems.org'

  gem 'rails'
  gem 'blacklight'
  gem 'hydra-head', '~> 10.0'

To install all of the dependencies, run:

bundle install

Run the generators and migrations:

Run the blacklight generator

rails g blacklight:install --devise

Run the hydra-head generator

rails g hydra:head -f

Run the database migrations

rake db:migrate

You're done.

Congratulations. You've set up the code for your Hydra Head.

Read Tools for Developing and Testing your Application, then read How to Get Started to get a sense of what you can do with your Hydra Head.

Modifying and Testing the hydra-head Gem

For those developers who want to or need to work on the hydra-head gem itself, see the Instructions for Contributors

Acknowledgments

This software has been developed by and is brought to you by the Samvera community. Learn more at the Samvera website.

Samvera Logo