黑光灯

黑光

分支机构

• 目前，我们在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 许可证公开。

安装

将 Blacklight 添加到您的Gemfile中：

 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 附带了 Javascript，可以通过 Webpacker 或 Sprockets 进行编译。要使用 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