projectblacklight/spotlight

Name: spotlight

Owner: Project Blacklight

Description: Spotlight enables librarians, curators, and others who are responsible for digital collections to create attractive, feature-rich websites that highlight these collections.

Created: 2013-11-19 19:49:19.0

Updated: 2017-10-23 15:08:54.0

Pushed: 2018-01-18 22:08:41.0

Homepage: http://spotlight.projectblacklight.org

Size: 9359

Language: Ruby

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

spotlight

| | | 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.2.0 or greater)
2. Rails (5.0 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:

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

or from an existing Rails application:

ils 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:

 app-name

Run the database migrations:

ke db:migrate

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

lr_wrapper 

and the Rails development server:

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

More

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.

More Information for Developers

• Contributing to Spotlight

Tests

Run all the tests:

ke

This utilizes Solr and the testing rails app automatically.