Skip to content
Spotlight enables librarians, curators, and others who are responsible for digital collections to create attractive, feature-rich websites that highlight these collections.
Branch: master
Clone or download
Latest commit d84c016 Mar 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Avoid using javascript keywords as variable names Mar 12, 2019
bin
config Allow dots to appear in the identifier (#2141) Mar 11, 2019
db/migrate
lib Bump version to 2.4.1 Mar 12, 2019
solr_conf/conf Update configuration to support Solr 7.2 (#1876) Jan 12, 2018
spec Allow dots to appear in the identifier (#2141) Mar 11, 2019
vendor/assets
.coveralls.yml add code coverage stats and coveralls integration Feb 1, 2014
.gitignore
.hound.yml
.jshintrc so there is no confusion about which style approach and local editors… Mar 24, 2018
.rspec
.rubocop.yml
.rubocop_todo.yml
.scss-lint.yml Add hound configuration for javascript and css styling Nov 22, 2015
.solr_wrapper
.travis.yml Update .travis.yml Jan 9, 2019
Gemfile
LICENSE
README.md Add link to Translations wiki page May 4, 2018
Rakefile
blacklight-spotlight.gemspec Allow dots to appear in the identifier (#2141) Mar 11, 2019
template.rb

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

You can’t perform that action at this time.