lumière noire

Lumière noire

Succursales

• La branche main est actuellement l'endroit où nous effectuons le nouveau développement pour la prochaine version 9.0.
• La série 8.x est sur la branche release-8.x
• La série 7.x est sur la branche release-7.x
• La série 6.x est sur la branche release-6.x

Description

Blacklight est une plateforme open source de découverte d'interface utilisateur Solr. Vous pouvez utiliser Blacklight pour activer la recherche et la navigation dans vos collections. Blacklight utilise le moteur de recherche Apache Solr pour rechercher du texte intégral et/ou des métadonnées. Blacklight dispose d'un frontal Ruby on Rails hautement configurable. Blacklight a été initialement développé à la bibliothèque de l'Université de Virginie et est rendu public sous une licence Apache 2.0.

Installation

Ajoutez Blacklight à votre Gemfile :

 gem "blacklight"

Exécutez le générateur d'installation qui copiera certains modèles, migrations, itinéraires et configuration initiaux :

rails generate blacklight:install

Documentation, informations et assistance

• Page d'accueil du projet
• Documentation du développeur
• Guide de démarrage rapide
• Test et développement de Blacklight
• Suivi des problèmes
• Soutien

Compatibilité du navigateur

Blacklight suppose un navigateur moderne prenant en charge Baseline 2023. Cela signifie que nous ne prenons explicitement pas en charge Internet Explorer.

Dépendances

• Rubis 3.1+
• Ruby sur Rails 6.1+

Blacklight vise à prendre en charge les versions actuellement prises en charge de Ruby et les versions prises en charge de Ruby on Rails. Nous visons à maintenir notre configuration de test à jour avec ces versions prises en charge.

Code contributeur

Les contributions au code sont toujours les bienvenues, les instructions pour contribuer peuvent être trouvées sur CONTRIBUTING.md.

Configuration d'Apache Solr

Vous aurez également besoin d'informations sur la façon dont Blacklight s'attend à ce qu'Apache Solr s'exécute, que vous pouvez trouver dans Configuration de Solr.

Construire le javascript

Le javascript est construit par npm à partir des sources de app/javascript dans un bundle dans app/assets/javascripts/blacklight/blacklight.js . Ce fichier ne doit pas être modifié manuellement car toute modification serait écrasée. Lorsque l'un des composants javascript de la gem est modifié, ce bundle doit être reconstruit en suivant les étapes suivantes :

1. Installer npm
2. exécutez npm install pour télécharger les dépendances
3. exécutez npm run prepare à créer le bundle
4. exécutez npm publish pour pousser le package javascript vers https://npmjs.org/package/blacklight-frontend

Utiliser le javascript

Blacklight est livré avec Javascript qui peut être compilé soit par Webpacker, soit par Sprockets. Pour utiliser Webpacker, consultez les instructions sur https://github.com/projectblacklight/blacklight/wiki/Using-Webpacker-to-compile-javascript-assets

Si vous préférez utiliser Sprockets, exécutez simplement le générateur d'installation, qui exécutera le générateur d'actifs. Pour plus de détails, voir https://github.com/projectblacklight/blacklight/wiki/Using-Sprockets-to-compile-javascript-assets