luz negra

Luz negra

Galhos

• O branch main é atualmente onde fazemos novos desenvolvimentos para a próxima versão 9.0.
• A série 8.x está no branch release-8.x
• A série 7.x está no branch release-7.x
• A série 6.x está no branch release-6.x

Descrição

Blacklight é uma plataforma de descoberta de interface de usuário Solr de código aberto. Você pode usar o Blacklight para permitir a pesquisa e navegação em suas coleções. Blacklight usa o mecanismo de busca Apache Solr para pesquisar texto completo e/ou metadados. Blacklight tem um front-end Ruby on Rails altamente configurável. Blacklight foi originalmente desenvolvido na Biblioteca da Universidade da Virgínia e é tornado público sob uma licença Apache 2.0.

Instalação

Adicione Blacklight ao seu Gemfile :

 gem "blacklight"

Execute o gerador de instalação que copiará alguns modelos iniciais, migrações, rotas e configuração:

rails generate blacklight:install

Documentação, Informação e Suporte

• Página inicial do projeto
• Documentação do desenvolvedor
• Guia de início rápido
• Testando e desenvolvendo Blacklight
• Rastreador de problemas
• Apoiar

Compatibilidade do navegador

Blacklight assume um navegador moderno com suporte para Baseline 2023. Isso significa que explicitamente não oferecemos suporte ao Internet Explorer.

Dependências

• Rubi 3.1+
• Ruby on Rails 6.1+

Blacklight visa oferecer suporte às versões atualmente suportadas do Ruby e às versões suportadas do Ruby on Rails. Nosso objetivo é manter nossa configuração de teste atualizada com essas versões suportadas.

Código de contribuição

Contribuições de código são sempre bem-vindas. As instruções para contribuir podem ser encontradas em CONTRIBUTING.md.

Configurando o Apache Solr

Você também vai querer algumas informações sobre como o Blacklight espera que o Apache Solr seja executado, que você pode encontrar em Configuração do Solr

Construindo o javascript

O javascript é construído pelo npm a partir de fontes em app/javascript em um pacote em app/assets/javascripts/blacklight/blacklight.js . Este arquivo não deve ser editado manualmente, pois quaisquer alterações seriam substituídas. Quando qualquer um dos componentes javascript na gem for alterado, este pacote deve ser reconstruído com as seguintes etapas:

1. Instalar npm
2. execute npm install para baixar dependências
3. execute npm run prepare para construir o pacote
4. execute npm publish para enviar o pacote javascript para https://npmjs.org/package/blacklight-frontend

Usando o javascript

O Blacklight vem com Javascript que pode ser compilado pelo Webpacker ou pelo Sprockets. Para usar o Webpacker, consulte as instruções em https://github.com/projectblacklight/blacklight/wiki/Using-Webpacker-to-compile-javascript-assets

Se preferir usar Sprockets, basta executar o gerador de instalação, que executará o gerador de ativos. Para obter detalhes, consulte https://github.com/projectblacklight/blacklight/wiki/Using-Sprockets-to-compile-javascript-assets