ブラックライト

ブラックライト

支店

• 現在、 mainブランチは、次の 9.0 リリースに向けた新しい開発を行う場所です。
• 8.xシリーズは release-8.x ブランチにあります
• 7.xシリーズは release-7.x ブランチにあります
• 6.xシリーズは release-6.x ブランチにあります

説明

Blacklight は、オープンソースの Solr ユーザー インターフェイス検出プラットフォームです。 Blacklight を使用すると、コレクションの検索と参照が可能になります。 Blacklight は、Apache Solr 検索エンジンを使用してフルテキストやメタデータを検索します。 Blacklight には、高度に構成可能な Ruby on Rails フロントエンドが備わっています。 Blacklight はもともとバージニア大学図書館で開発され、Apache 2.0 ライセンスに基づいて公開されています。

インストール

Gemfileに Blacklight を追加します。

 gem "blacklight"

いくつかの初期テンプレート、移行、ルート、構成をコピーするインストール ジェネレーターを実行します。

rails generate blacklight:install

ドキュメント、情報、サポート

• プロジェクトのホームページ
• 開発者向けドキュメント
• クイックスタートガイド
• ブラックライトのテストと開発
• 問題追跡ツール
• サポート

ブラウザの互換性

Blacklight は、Baseline 2023 をサポートする最新のブラウザを前提としています。これは、Internet Explorer を明示的にサポートしていないことを意味します。

依存関係

• ルビー 3.1+
• Ruby on Rails 6.1+

Blacklight は、現在サポートされているバージョンの Ruby とサポートされているバージョンの Ruby on Rails をサポートすることを目的としています。これらのサポートされているバージョンを使用して、テスト構成を最新の状態に保つことを目指しています。

貢献コード

コードの貢献はいつでも歓迎されます。貢献の手順は CONTRIBUTING.md にあります。

Apache Solr の構成

また、Blacklight が Apache Solr の実行をどのように想定しているかについての情報も必要です。これは、「Solr 設定」で見つけることができます。

JavaScriptの構築

JavaScript は npm によってapp/javascriptのソースからapp/assets/javascripts/blacklight/blacklight.jsのバンドルにビルドされます。変更が上書きされるため、このファイルを手動で編集しないでください。 gem 内の JavaScript コンポーネントのいずれかが変更された場合、このバンドルは次の手順で再構築する必要があります。

1. npmをインストールする
2. npm install実行して依存関係をダウンロードする
3. npm run prepare 。
4. npm publishを実行して、javascript パッケージを https://npmjs.org/package/blacklight-frontend にプッシュします。

JavaScriptの使用

Blacklight には、Webpacker または Sprockets でコンパイルできる Javascript が同梱されています。 Webpacker を使用するには、https://github.com/projectblacklight/blacklight/wiki/Using-Webpacker-to-compile-javascript-assets の手順を参照してください。

Sprockets を使用したい場合は、インストール ジェネレーターを実行するだけで、アセット ジェネレーターが実行されます。詳細については、https://github.com/projectblacklight/blacklight/wiki/Using-Sprockets-to-compile-javascript-assets を参照してください。