spotlight

| | | Release Notes | Design Documents

Spotlight is intended to enable librarians, curators, and others who are responsible for digital collections to create attractive, feature-rich websites that feature these collections. The curator should be able to use Spotlight to produce a website that highlights a digital collection, drawn from a digital library repository, entirely on his or her own, without programming. The development and ongoing management of the website should be relatively simple and follow familiar conventions for producing online content (e.g., similar to writing and managing a blog or working with a content management system).

Demo Videos

• Sprint 9
• Sprint 8
• Sprint 7
• Sprint 6
• Sprint 5
• Sprint 4
• Sprint 3
• Sprint 2
• Sprint 1

Tests

Run tests:

$ rake

Installation

To bootstrap a new Rails application:

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

or

$ rake rails:template LOCATION=https://raw.githubusercontent.com/sul-dlss/spotlight/master/template.rb

Or do it manually:

Add this line to your application's Gemfile:

gem 'blacklight-spotlight'

And then execute:

$ bundle

Then run:

$ rails g spotlight:install

Create an administrator

$ rake spotlight:initialize

To set up your development environment

Note: rake commands MAY need to be prefixed with bundle exec, depending on your environment.

1. Clone this repo, cd in and run $ bundle install
2. Get and configure Jetty/Solr:
   1. $ rake jetty:download
   2. $ rake jetty:unzip
   3. $ rake spotlight:configure_jetty
3. Generate the internal test application (will be in spec/internal): $ rake engine_cart:generate
4. Start Jetty $ rake jetty:start (may take a moment, use e.g. $ fuser 8983/tcp or $ ps aux | grep jetty to see when it's actually up)
5. Index fixtures: TEST_JETTY_PORT=8983 rake spotlight:fixtures
6. $ cd spec/internal
7. Run $ rake spotlight:initialize and answer prompts
8. Start the dev server rails s
9. Visit http://localhost:3000 and sign in.