черный свет

Блэклайт

Филиалы

• В настоящее время в 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
• Трекер проблем
• Поддерживать

Совместимость браузера

Blacklight предполагает использование современного браузера с поддержкой Baseline 2023. Это означает, что мы явно не поддерживаем Internet Explorer.

Зависимости

• Рубин 3.1+
• Руби на рельсах 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 . Этот файл не следует редактировать вручную, поскольку любые изменения будут перезаписаны. При изменении любого из компонентов javascript в драгоценном камне этот пакет следует пересобрать, выполнив следующие действия:

1. Установить НПМ
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.