README.md

Spotlight example for the Spotlight Day developer track

System dependencies

• Ruby 2.2 or greater
• Java 8 or greater
• ImageMagick (http://www.imagemagick.org/script/index.php), for carrierwave image processing

GoRails provides a tutorial for preparing your machine for Rails development on OS X and Linux.

Getting Started

Cloning the project:

$ git clone https://github.com/projectblacklight/spotlight_day_demo.git # preferred, or:
# download https://github.com/projectblacklight/spotlight_day_demo/archive/master.zip

$ cd spotlight_day_demo

Installing the dependencies:

$ bin/setup
# this runs `bundle install`, `rake db:setup`, and does environment sanity checks

Running the tests:

$ bundle exec rake ci

Creating an initial administrator:

$ bundle exec rake spotlight:initialize

Running the rails server:

$ bundle exec rails server

Starting solr:

# in a new terminal:
$ bundle exec solr_wrapper

References

• Blacklight wiki
• Spotlight wiki
• Customizing Blacklight tutorial
• blacklight/configuration.rb
• spotlight/engine.rb configuration
• Rails guides
• Solr Reference Guide