Schwarzlicht

Schwarzlicht

Zweige

• Im main führen wir derzeit Neuentwicklungen für die kommende Version 9.0 durch.
• Die 8.x Serie befindet sich im Release-8.x-Zweig
• Die 7.x Serie befindet sich im Release-7.x-Zweig
• Die 6.x Serie befindet sich im Release-6.x-Zweig

Beschreibung

Blacklight ist eine Open-Source-Plattform zur Erkennung von Solr-Benutzeroberflächen. Sie können Blacklight verwenden, um das Durchsuchen und Durchsuchen Ihrer Sammlungen zu ermöglichen. Blacklight verwendet die Suchmaschine Apache Solr, um Volltext und/oder Metadaten zu durchsuchen. Blacklight verfügt über ein hochgradig konfigurierbares Ruby on Rails-Frontend. Blacklight wurde ursprünglich an der University of Virginia Library entwickelt und wird unter einer Apache 2.0-Lizenz veröffentlicht.

Installation

Fügen Sie Blacklight zu Ihrer Gemfile hinzu:

 gem "blacklight"

Führen Sie den Installationsgenerator aus, der einige anfängliche Vorlagen, Migrationen, Routen und Konfigurationen kopiert:

rails generate blacklight:install

Dokumentation, Informationen und Support

• Projekt-Homepage
• Entwicklerdokumentation
• Schnellstartanleitung
• Schwarzlicht testen und entwickeln
• Issue-Tracker
• Unterstützung

Browserkompatibilität

Blacklight geht von einem modernen Browser mit Unterstützung für Baseline 2023 aus. Das bedeutet, dass wir den Internet Explorer ausdrücklich nicht unterstützen.

Abhängigkeiten

• Ruby 3.1+
• Ruby on Rails 6.1+

Blacklight zielt darauf ab, die aktuell unterstützten Versionen von Ruby und die unterstützten Versionen von Ruby on Rails zu unterstützen. Unser Ziel ist es, unsere Testkonfiguration mit diesen unterstützten Versionen auf dem neuesten Stand zu halten.

Mitwirkender Code

Code-Beiträge sind immer willkommen. Anweisungen zum Mitwirken finden Sie unter CONTRIBUTING.md.

Konfigurieren von Apache Solr

Sie benötigen außerdem einige Informationen darüber, wie Blacklight die Ausführung von Apache Solr erwartet. Diese finden Sie in der Solr-Konfiguration

Erstellen des Javascripts

Das Javascript wird von npm aus Quellen in app/javascript in einem Bundle in app/assets/javascripts/blacklight/blacklight.js erstellt. Diese Datei sollte nicht manuell bearbeitet werden, da etwaige Änderungen überschrieben würden. Wenn eine der Javascript-Komponenten im Gem geändert wird, sollte dieses Bundle mit den folgenden Schritten neu erstellt werden:

1. Installieren Sie npm
2. Führen Sie npm install aus, um Abhängigkeiten herunterzuladen
3. Führen Sie npm run prepare um das Bundle zu erstellen
4. Führen Sie npm publish aus, um das Javascript-Paket an https://npmjs.org/package/blacklight-frontend zu pushen

Verwendung von Javascript

Blacklight wird mit Javascript geliefert, das entweder von Webpacker oder von Sprockets kompiliert werden kann. Informationen zur Verwendung von Webpacker finden Sie in den Anweisungen unter https://github.com/projectblacklight/blacklight/wiki/Using-Webpacker-to-compile-javascript-assets

Wenn Sie Sprockets bevorzugen, führen Sie einfach den Installationsgenerator aus, der den Asset-Generator ausführt. Einzelheiten finden Sie unter https://github.com/projectblacklight/blacklight/wiki/Using-Sprockets-to-compile-javascript-assets