Spotlight enables librarians, curators, and others who are responsible for digital collections to create attractive, feature-rich websites that highlight these collections.
Clone or download
Latest commit 3b30e82 Sep 11, 2018
Permalink
Failed to load latest commit information.
app fix rubocop 0.59 errors Sep 12, 2018
bin generate the rails mountable engine Nov 19, 2013
config Extract an edit_sidecar partial and use text areas for free-form text… Aug 15, 2018
db/migrate db: change taggable_id to integer (#2100) Sep 11, 2018
lib fix rubocop 0.59 errors Sep 12, 2018
solr_conf/conf Update configuration to support Solr 7.2 (#1876) Jan 12, 2018
spec fix rubocop 0.59 errors Sep 12, 2018
vendor/assets updates Leaflet-IIIF to v2.0.0 enabling negative minZoom Apr 4, 2018
.coveralls.yml add code coverage stats and coveralls integration Feb 1, 2014
.gitignore Add modern RSpec niceties Dec 6, 2016
.hound.yml so there is no confusion about which style approach and local editors… Mar 24, 2018
.jshintrc so there is no confusion about which style approach and local editors… Mar 24, 2018
.rspec Cleanup rspec (#1477) Jul 8, 2016
.rubocop.yml additional fixes to resolve build errors (#2091) Aug 15, 2018
.rubocop_todo.yml fix rubocop 0.59 errors Sep 12, 2018
.scss-lint.yml Add hound configuration for javascript and css styling Nov 22, 2015
.solr_wrapper Use solr_wrapper and Solr 6 Jul 5, 2016
.travis.yml test with Rails 5.2.1 on travis Aug 15, 2018
Gemfile Drop Rails 4.2 support Aug 3, 2017
LICENSE Update meta-artifacts with content Jan 28, 2014
README.md Add link to Translations wiki page May 4, 2018
Rakefile Run db:migrate after setting up the test app, in case it was loaded f… Apr 17, 2018
blacklight-spotlight.gemspec additional fixes to resolve build errors (#2091) Aug 15, 2018
template.rb Explicitly require bundler dependency in the application template (#1528 Jul 31, 2016

README.md

spotlight

Build Status | Gem Version | Release Notes | Design Documents

Spotlight is open source software that enables librarians, curators, and other content experts to easily build feature-rich websites that showcase collections and objects from a digital repository, uploaded items, or a combination of the two. Spotlight is a plug-in for Blacklight, an open source, Ruby on Rails Engine that provides a basic discovery interface for searching an Apache Solr index.

Read more about what Spotlight is, our motivations for creating it, and how to install and configure it in the wiki pages. You might also want to take a look at our demo videos, especially the tour of a completed Spotlight exhibit and the walkthrough of building an exhibit with Spotlight.

Requirements

  1. Ruby (2.3.0 or greater)
  2. Rails (5.1 or greater)
  3. Java (7 or greater) for Solr
  4. ImageMagick (http://www.imagemagick.org/script/index.php) due to carrierwave

Installation

To bootstrap a new Rails application:

$ rails new app-name -m https://raw.githubusercontent.com/projectblacklight/spotlight/master/template.rb

or from an existing Rails application:

$ rails app:template LOCATION=https://raw.githubusercontent.com/projectblacklight/spotlight/master/template.rb

During this process you will be prompted to enter an initial administrator email and password (this is a super-admin that can administer any exhibit in the installation). If you choose not to create one, the first user will be given administrative privileges.

Change directories to your new application:

$ cd app-name

Run the database migrations:

$ rake db:migrate

Start Solr (possibly using solr_wrapper in development or testing):

$ solr_wrapper

and the Rails development server:

$ rails server

Go to http://localhost:3000 in your browser.

Configuration

Default ActionMailer configuration

Spotlight introduces functionality that depends on being able to send emails to exhibit curators and contacts. Be sure to configure your application's environments appropriately (see the Rails Guide for Action Mailer Configuration).

See the Spotlight wiki for more detailed information on configuring Spotlight.

Developing Spotlight

Spotlight:

  • is a Rails engine and needs to be used in the context of a Rails application. We use engine_cart to create an internal test application at .internal_test_app/
  • uses Solr as part of its integration tests. We use solr_wrapper to manage the Solr instance used for development and test.

Our $ rake ci and $ rake spotlight:server tasks utilize Solr and the testing rails app automatically.

See more detailed instructions for development environment setup at "Contributing to Spotlight"

Tests

Run all the tests:

$ rake

This utilizes Solr and the testing rails app automatically.

Translations

Spotlight ships with i18n-tasks to help manage translations. To run a translation health check:

$ bundle exec i18n-tasks health

See developer-facing instructions for enabling translation on the wiki.

Community