Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Spotlight enables librarians, curators, and others who are responsible for digital collections to create attractive, feature-rich websites that highlight these collections.
Ruby JavaScript HTML CSS

Merge pull request #1118 from sul-dlss/solr-api

Provide API access to get or enrich a solr document with exhibit-specific data
latest commit 58207804ad
@jkeck jkeck authored

README.md

spotlight

Build Status | Coverage 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.0.0 or greater)
  2. Rails (4.2.0 or greater)
  3. Java (7 or greater) for solr
  4. ImageMagick

Installation

To bootstrap a new Rails application:

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

or from an existing Rails application:

$ rake rails:template LOCATION=https://raw.githubusercontent.com/sul-dlss/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:

$ rake jetty:start

Start the rails development server:

$ rails s

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).

More

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

To start the development/test application

  1. Clone this repo, cd in and run $ bundle install
  2. Start jetty and the dev server: $ bundle exec rake spotlight:server (this task will build a Spotlight-based application, start Solr, and run the built-in rails server)
  3. Visit http://localhost:3000

Tests

Run tests:

$ rake
Something went wrong with that request. Please try again.