This repository has been archived by the owner. It is now read-only.
🐐 Heiðrún ingests metadata
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
lib
log
provisioning
public
solr_conf
spec
test
vendor
.gitignore
.ruby-version
.travis.yml
Changelog.md
Gemfile
LICENSE
README.md
Rakefile
Vagrantfile
config.ru

README.md

Heiðrún (heidrun)

Build Status Code Climate Test Coverage

Heiðrún is the DPLA metadata ingestion and QA system, and is an implementation of the Kri-kri Rails engine.

Heidrun, Icelandic Manuscript, SÁM 66, Árni Magnússon Institute for Icelandic Studies

More information about Heidrun and Kri-kri can be found on DPLA's Technology Team site.

Installation

Run these commands:

bundle install
bundle exec rake db:migrate

Using Vagrant for Development

Prerequisites:

Add this line to your /etc/hosts or equivalent:

192.168.50.21   heidrun

Then do this:

$ cd /path/to/this/directory
$ vagrant up
$ vagrant reload  # Because of o/s packages having been upgraded
$ vagrant ssh
$ cd /vagrant
$ bundle exec rake jetty:start
$ bundle exec rake db:migrate
$ bundle exec rails s

You should be able to browse to http://heidrun:3000/ to see the application.

You may re-run the provisioning with vagrant provision.

To run tests, make sure jetty is not already running, and then run rake ci:

$ bundle exec rake jetty:stop
$ bundle exec rake ci

Please see the notes in our automation project README regarding the use of this VM.

About the name

In Norse mythology, Heiðrún is the goat that consumes leaves from the tree Læraðr and produces mead for the einherjar.

Contribution Guidelines

Please observe the following guidelines:

  • Write tests for your contributions.
  • Document methods you add using YARD annotations.
  • Use well formed commit messages.

Copyright & License

  • Copyright Digital Public Library of America, 2014-2017
  • License: MIT