Blacklight is an open source Solr user interface discovery platform. You can use Blacklight to enable searching and browsing of your collections. Blacklight uses the Apache Solr search engine to search full text and/or metadata. Blacklight has a highly configurable Ruby on Rails front-end. Blacklight was originally developed at the University of Virginia Library and is made public under an Apache 2.0 license.
Add Blacklight to your
Run the install generator which will copy over some initial templates, migrations, routes, and configuration:
rails generate blacklight:install
Documentation, Information and Support
- Project Homepage
- Developer Documentation
- Quickstart Guide
- Testing and Developing Blacklight
- Issue Tracker
Blacklight assumes a modern browser with support for ES6. This means we explicitly do not support Internet Explorer 11.
- Ruby 2.7+
- Ruby on Rails 6.1+
Blacklight aims to support the currently supported versions of Ruby and the supported versions of Ruby on Rails. We aim to keep our test configuration up to date with these supported versions.
Code contributions are always welcome, instructions for contributing can be found at CONTRIBUTING.md.
Configuring Apache Solr
You'll also want some information about how Blacklight expects Apache Solr to run, which you can find in Solr Configuration
components in the gem are changed, this bundle should be rebuild with the
- Install npm
npm installto download dependencies
npm run prepareto build the bundle