Codebase for Fulcrum, an in-development Samvera-based digital publishing platform built by the University of Michigan Library
Ruby HTML CSS JavaScript XSLT Shell
sethaj Merge pull request #1950 from mlibrary/2047_batch_form
get batch create Monographs to work
Latest commit 194a56f Aug 14, 2018
Permalink
Failed to load latest commit information.
.wrap_conf bump version Oct 6, 2017
app Merge pull request #1950 from mlibrary/2047_batch_form Aug 14, 2018
bin extract script and method Jun 28, 2018
config Merge pull request #1949 from mlibrary/2059_Gabii_TOC Aug 13, 2018
db Resolves HELIO-1732: API Audit Log Jul 10, 2018
fulcrum add blog post announcing launch of HEB Jul 30, 2018
lib Resolves HELIO-2059: Gabii TOC link to last page Aug 13, 2018
log Generate Rails Mar 3, 2016
ruumba Resolves HELIO-1966: Display complete TOC Aug 1, 2018
script Purge Metadata Rake Task Script Jul 17, 2018
solr/config Resolves #962, Upgrade to Hyrax 2 Nov 15, 2017
spec Merge pull request #1949 from mlibrary/2059_Gabii_TOC Aug 13, 2018
tmp Update to Rails 5.1.3 Oct 18, 2017
vagrant_scripts Vagrant - refactor, provision MySQL Jul 10, 2017
vendor simplify Able Player tweaks Dec 14, 2017
.fcrepo_wrapper Resolves #1235 Monograph Representative Manifest CSV Oct 1, 2017
.gitignore AEIM-1324 - Add KCV, update Keycard, Checkpoint Jul 20, 2018
.rspec Install rspec and test on Travis Mar 3, 2016
.rubocop.yml Resolves HELIO-1877 Institutional's Shibboleth EntityId And Embedded Jun 9, 2018
.rubocop_todo.yml add new fields to the presses database; modify views to incorporate d… Jun 25, 2018
.ruby-version Resolves #1372, update ruby version and start using rbenv-aliases Nov 27, 2017
.solr_wrapper Bump Solr to 6.5.1 Apr 27, 2017
.travis.yml Resolves #1372, update ruby version and start using rbenv-aliases Nov 27, 2017
.yardopts yard for doc Apr 21, 2018
Gemfile update CSB resync branch and move call to open_panel to improve Gabii… Jul 24, 2018
Gemfile.lock update CSB resync branch and move call to open_panel to improve Gabii… Jul 24, 2018
LICENSE.txt move to Apache 2.0 license Oct 19, 2017
README.md Integrate Shibboleth Authentication Jul 3, 2018
Rakefile Add sitemap for SEO (#1107). Nov 6, 2017
Vagrantfile Vagrant - refactor, provision MySQL Jul 10, 2017
config.ru Update to Rails 5.1.3 Oct 18, 2017
package.json Update to Rails 5.1.3 Oct 18, 2017

README.md

Heliotrope

Code: Build Status Coverage Status

Jump In: Issue Tracker

Table of Contents

What is Fulcrum? What is Heliotrope?

Fulcrum is an in-development publishing platform and set of hosting and publishing services aimed to help scholarly publishers present the full richness of their authors' research outputs in a durable, discoverable, and flexible form. Its first phase of development is focused on providing branded companion websites for books. Now, in its second phase, it will expand to host complete e-book collections, journals, and new forms of multimodal publications as well as provide a set of hosting and publishing services for publishers.

Heliotrope is the codebase behind the Fulcrum publishing platform. It is a Rails application that extends Hyrax–the popular front-end repository solution from the Samvera open source community–to provide solutions for scholarly publishers.

It is built by the University of Michigan Library and managed by the Library's publishing division, Michigan Publishing.

Feature List

In addition to the features that come with Hyrax, Heliotrope offers the following:

  • Web-based e-book reader for FileSets that are valid EPUBs. The e-book reader is delivered as a single-page JS application that is included with Heliotrope as a gem. See the wiki for more details and features specific to the e-book reader. (Example)
  • Publisher catalog page listing Works associated with publisher (Example).
  • Customized branding (logo, colors, fonts) for publisher that is applied to associated Works and FileSets (Example).
  • Publisher-specific usage analytics (eg, support for multiple Google Analytics IDs on a single page, allowing each publisher to have their own Google Analytics property).
  • Bulk importer for Works and their children.
  • Embed codes for FileSets, allowing FileSets to be embedded into external websites and EPUB files.
  • Support for FileSets that are hosted externally (Example).
  • Additional metadata fields for Books and their associated media.
  • Accessibility improvements to meet Section 508 and WCAG 2.0AA guidelines.
  • Delivery of time-based media through an accessible media player, AblePlayer. Support for transcripts and captions when provided (Example).
  • Delivery of IIIF-served images using Leaflet (Example).
  • Integration with Jekyll static-site generator for "aboutware" static pages and blog.

Help/Contact

For additional details and helpful hints read our ever growing Wiki. To get in touch with us over e-mail, contact the Fulcrum Developers List. To stay updated with developments in Heliotrope and Fulcrum, sign-up for our newsletter.

Getting started

Prerequisites

Initial setup

1. Getting a local copy, bundle install gems, and execute setup script

$ git clone https://github.com/mlibrary/heliotrope.git
$ cd heliotrope
$ bundle install
$ ./bin/bundle exec ./bin/setup

See the Wiki for information on Jekyll integration.

2. Create users

Make yourself a "platform" admin

There is a rails task you can execute to create a "platform" admin user. It will prompt you for an email address and then create a user with the correct role.

$ ./bin/bundle exec ./bin/rails admin

If you need to run this when the app has been deployed, execute:

$ RAILS_ENV=production ./bin/bundle exec ./bin/rails admin

3. Run the application

Execute this command to start Fedora, Solr and Rails servers:

$ ./bin/bundle exec ./bin/rails hydra:server

Or, if you prefer to start each server individually execute each of the following commands in a seperate shells: (you must use this alternate option if running on a VM)

$ redis-server /usr/local/etc/redis.conf
$ fcrepo_wrapper -p 8984 --no-jms
$ solr_wrapper -p 8983 -d solr/config/ --collection_name hydra-development
$ ./bin/bundle exec ./bin/rails s

NOTE: You'll also want to make sure that you have MySQL started.

NOTE: There are also config files available for running the wrappers (which save you from having to remember ports, collection names etc). Their settings attempt to persist your Solr index as you move between dev and test. Use like so:

$ fcrepo_wrapper --config .wrap_conf/fcrepo_dev
$ solr_wrapper --config .wrap_conf/solr_dev

4. Create default administrative set

$ ./bin/bundle exec ./bin/rails hyrax:default_admin_set:create

Debugging

Explain Partials

When running Rails server, set the EXPLAIN_PARTIALS environment variable to show partials being rendered in source html of your views. You can view this info using your browser's inspect element mode.

$ EXPLAIN_PARTIALS=true ./bin/bundle exec ./bin/rails s

NOTE: Because this feature can add a fair bit of overhead, it is restricted to only run in development mode.

Testing

To execute the continuous integration task run by Travis CI

$ ./bin/bundle exec ./bin/rails ci

Starting servers individually when testing

Alternatively, you can start up each server individually. This may be preferable because the ci task starts up and tears down Fedora and Solr before/after the test suite is run.

1. Start up FCrepo

$ fcrepo_wrapper -p 8986 --no-jms

or

$ fcrepo_wrapper --config .wrap_conf/fcrepo_test

2. Start up Solr

$ solr_wrapper -p 8985 -d solr/config/ --collection_name hydra-test

or

$ solr_wrapper --config .wrap_conf/solr_test

3. Run tests

$ ./bin/bundle exec ./bin/rails rubocop
$ ./bin/bunlde exec ./bin/rails ruumba
$ ./bin/bundle exec ./bin/rails lib_spec
$ ./bin/bundle exec rspec

Running specs individually

To run individual specs located in the ./lib/spec directory (a.k.a lib_spec) first step into the lib directory and then execute rspec.

$ cd lib
$ ../bin/bundle exec rspec

Special note on running tests

As of June 20, 2017 there are tests that require the static pages to be built in order for routing to happen correctly (See Static Pages and Blog documentation). This means you need to execute

$ ./bin/bundle exec ./bin/rails jekyll:deploy

before running rspec. This only need be executed once. If you followed step 1 of the initial setup then you did this already.

License

Heliotrope is available under the Apache 2.0 license.

Contributing

We'd love to accept your contributions and there are lots of ways to engage with the Fulcrum project and Heliotrope codebase even if you aren't a developer. Please see our contributing guidelines for how you can get involved.

Please note: As of May 14 2018, we have migrated our issues to a JIRA project and are no longer creating new issues in GitHub. All GitHub issues that were open at the time of migration will be updated with relevant links to the corresponding JIRA issue. If you find bugs or would like to open an issue, you can still use GitHub for that to open the conversation with Fulcrum developers.

Acknowledgements

Initial development has been supported by a generous grant from the Andrew W. Mellon Foundation and implemented by the University of Michigan Library and Press working with partners from Indiana, Minnesota, Northwestern, and Penn State universities and Data Curation Experts.