blacklight-frontend
Advanced tools
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 Gemfile:
gem "blacklight"
Run the install generator which will copy over some initial templates, migrations, routes, and configuration:
rails generate blacklight:install
Blacklight assumes a modern browser with support for Baseline 2023. This means we explicitly do not support Internet Explorer.
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.
You'll also want some information about how Blacklight expects Apache Solr to run, which you can find in Solr Configuration
The javascript is built by npm from sources in app/javascript into a bundle
in app/assets/javascripts/blacklight/blacklight.js. This file should not be edited
by hand as any changes would be overwritten. When any of the javascript
components in the gem are changed, this bundle should be rebuild with the
following steps:
npm install to download dependenciesnpm run prepare to build the bundlenpm publish to push the javascript package to https://npmjs.org/package/blacklight-frontendBlacklight ships with Javascript that can be compiled either by Webpacker or by Sprockets. To use Webpacker see the directions at https://github.com/projectblacklight/blacklight/wiki/Using-Webpacker-to-compile-javascript-assets
If you prefer to use Sprockets, simply run the install generator, which will run the assets generator. For details see https://github.com/projectblacklight/blacklight/wiki/Using-Sprockets-to-compile-javascript-assets
FAQs
The frontend code and styles for Blacklight
We found that blacklight-frontend demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 12 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh joins Risky Business Weekly to unpack recent npm phishing attacks, their limited impact, and the risks if attackers get smarter.
Product
Socket’s new Tier 1 Reachability filters out up to 80% of irrelevant CVEs, so security teams can focus on the vulnerabilities that matter.
Research
/Security News
Ongoing npm supply chain attack spreads to DuckDB: multiple packages compromised with the same wallet-drainer malware.