Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samvera/hydra-head
Samvera Repository Rails Engine
https://github.com/samvera/hydra-head
core-components samvera-community
Last synced: 1 day ago
JSON representation
Samvera Repository Rails Engine
- Host: GitHub
- URL: https://github.com/samvera/hydra-head
- Owner: samvera
- License: other
- Created: 2011-03-11T05:48:12.000Z (almost 14 years ago)
- Default Branch: main
- Last Pushed: 2024-03-05T20:09:16.000Z (10 months ago)
- Last Synced: 2024-05-06T21:02:25.073Z (8 months ago)
- Topics: core-components, samvera-community
- Language: Ruby
- Homepage:
- Size: 134 MB
- Stars: 97
- Watchers: 68
- Forks: 41
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# Hydra-Head
Code: [](http://badge.fury.io/rb/hydra-head)
[](https://circleci.com/gh/samvera/hydra-head)
[](https://coveralls.io/github/samvera/hydra-head?branch=main)
Docs: [](./CONTRIBUTING.md)
[](./LICENSE)
Community Support: [](http://slack.samvera.org/)
# 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](http://samvera.github.io/core_components.html#requirements-for-a-core-component).
### Product Owner
[cjcolvar](https://github.com/cjcolvar)
# Help
The Samvera community is here to help. Please see our [support guide](./.github/SUPPORT.md).
See the Github wikis for information targeted to developers:
See the Duraspace Hydra wikis for information at the architecture level:
Additionally, new adopters and potential adopters may find the pages here useful:
Further questions? [Get in touch](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391)
## Installation/Setup
### Installation Prerequisites
See the [Installation Prerequisites](http://github.com/samvera/hydra-head/wiki/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](http://gembundler.com/gemfile.html) 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](http://github.com/samvera/hydra-head/wiki/Tools-for-Developing-and-Testing-your-Application),
then read [How to Get
Started](http://github.com/samvera/hydra-head/wiki/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](http://github.com/samvera/hydra-head/wiki/For-Contributors)
# Acknowledgments
This software has been developed by and is brought to you by the Samvera community. Learn more at the
[Samvera website](http://samvera.org/).
