Skip to content
Stanford University Libraries online exhibits showcase
Branch: master
Clone or download
Latest commit 1502c42 Mar 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin Update to Rails 5.2 (#1186) Jun 1, 2018
config
db
lib
log
public
solr/config
spec No coveralls (#1305) Dec 11, 2018
vendor/assets
.gitignore
.hound.yml
.rspec
.rubocop.yml
.rubocop_todo.yml
.scss-lint.yml
.solr_wrapper.yml update solr to 7.5.0 (#1257) Oct 29, 2018
.travis.yml
CHANGELOG.md Update CHANGELOG.md Dec 19, 2018
Capfile
Gemfile
Gemfile.lock
LICENSE
README.md No coveralls (#1305) Dec 11, 2018
Rakefile
config.ru

README.md

Build Status Code Climate Test Coverage

SUL Spotlight Exhibit

The project's master branch provides a template Spotlight application with SUL branding and functionality.

Configuration

Exhibits need to provide the following configuration files:

  • config/database.yml - Standard Rails database configuration
  • config/honeybadger.yml - Honeybadger.io exception reporting configuration
  • config/blacklight.yml - Blacklight solr configuration
  • config/initializers/secret_token.rb - Rails secret token

Reindexing content

A Rake task is provided to (re)index content into the Solr index. It uses the configured sets in config/exhibit.yml.

$ rake spotlight:index

A whenever-based cron task is configured to run nightly to keep the exhibit synchronized with the latest upstream changes. At this time, the task only adds or modifies records, and does not remove records that have been deleted or disassociated with the given OAI set.

Development

Requirements

  • Redis (for running background jobs with Sidekiq)

See projectblacklight/spotlight for additional requirements.

Install dependencies, set up the databases and run migrations:

$ bundle install
$ bundle exec rake db:setup

You can spin up the Rails server, solr_wrapper, and populate the Solr index using this command:

$ REMOTE_USER="archivist1@example.com" bundle exec rake server

When prompted to create an admin user, the email should match the email provided in REMOTE_USER. This will allow you to bypass the webauth authentication.

Testing

Run RuboCop and tests:

$ bundle exec rake

Tip: if you receive the error message ERROR: Core 'blacklight-core' already exists! you have an instance of Solr running elsewhere. Clean out your data with solr_wrapper clean or search for rogue instances with ps aux | grep solr.

Deploying

You must be on VPN to deploy the worker machine. Then deploy as usual using Capistrano:

$ cap stage deploy
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.