{"id":13558211,"url":"https://github.com/projectblacklight/blacklight","last_synced_at":"2025-05-13T19:07:36.337Z","repository":{"id":708993,"uuid":"355634","full_name":"projectblacklight/blacklight","owner":"projectblacklight","description":"Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr) index.","archived":false,"fork":false,"pushed_at":"2025-04-25T17:54:41.000Z","size":44970,"stargazers_count":766,"open_issues_count":160,"forks_count":255,"subscribers_count":67,"default_branch":"main","last_synced_at":"2025-04-25T18:21:48.291Z","etag":null,"topics":["blacklight","discovery-interface","rails-engine","ruby","solr"],"latest_commit_sha":null,"homepage":"http://projectblacklight.org/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/projectblacklight.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2009-10-30T20:03:30.000Z","updated_at":"2025-04-24T18:48:52.000Z","dependencies_parsed_at":"2023-07-06T01:55:27.652Z","dependency_job_id":"dfb2d150-01d2-41f9-b5f4-cc52f8af2315","html_url":"https://github.com/projectblacklight/blacklight","commit_stats":{"total_commits":3858,"total_committers":141,"mean_commits":"27.361702127659573","dds":0.7560912389839295,"last_synced_commit":"3381a591ee895aae0b3fb0cca6fd57f6c9c5507f"},"previous_names":[],"tags_count":285,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectblacklight%2Fblacklight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectblacklight%2Fblacklight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectblacklight%2Fblacklight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectblacklight%2Fblacklight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/projectblacklight","download_url":"https://codeload.github.com/projectblacklight/blacklight/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250869859,"owners_count":21500391,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blacklight","discovery-interface","rails-engine","ruby","solr"],"created_at":"2024-08-01T12:04:48.764Z","updated_at":"2025-04-27T04:46:03.555Z","avatar_url":"https://github.com/projectblacklight.png","language":"Ruby","readme":"# Blacklight\n\n![CI Workflow](https://github.com/projectblacklight/blacklight/actions/workflows/ruby.yml/badge.svg)\n\n## Branches\n\n* The `main` branch is currently where we do new development for the upcoming 9.0 release.\n* The `8.x` series is on the [release-8.x](https://github.com/projectblacklight/blacklight/tree/release-8.x) branch\n* The `7.x` series is on the [release-7.x](https://github.com/projectblacklight/blacklight/tree/release-7.x) branch\n* The `6.x` series is on the [release-6.x](https://github.com/projectblacklight/blacklight/tree/release-6.x) branch\n\n## Description\n\nBlacklight is an open source Solr user interface discovery platform.\nYou can use Blacklight to enable searching and browsing of your collections.\nBlacklight uses the [Apache Solr](http://lucene.apache.org/solr) search engine\nto search full text and/or metadata.  Blacklight has a highly\nconfigurable Ruby on Rails front-end. Blacklight was originally developed at\nthe University of Virginia Library and is made public under an Apache 2.0 license.\n\n## Installation\n\nAdd Blacklight to your `Gemfile`:\n\n```ruby\ngem \"blacklight\"\n```\n\nRun the install generator which will copy over some initial templates, migrations, routes, and configuration:\n\n```bash\nrails generate blacklight:install\n```\n\n\n## Documentation, Information and Support\n\n* [Project Homepage](http://projectblacklight.org)\n* [Developer Documentation](https://github.com/projectblacklight/blacklight/wiki)\n* [Quickstart Guide](https://github.com/projectblacklight/blacklight/wiki/Quickstart)\n* [Testing and Developing Blacklight](https://github.com/projectblacklight/blacklight/wiki/Testing-and-Developing-Blacklight)\n* [Issue Tracker](https://github.com/projectblacklight/blacklight/issues)\n* [Support](https://github.com/projectblacklight/blacklight/wiki/Support)\n\n## Browser Compatibility\n\nBlacklight assumes a modern browser with support for [Baseline 2023](https://web.dev/baseline/2023). This means we explicitly do not support Internet Explorer.\n\n## Dependencies\n\n* [Ruby](https://www.ruby-lang.org/) 3.1+\n* [Ruby on Rails](https://rubyonrails.org/) 6.1+\n\nBlacklight aims to support the currently [supported versions of Ruby](https://www.ruby-lang.org/en/downloads/branches/) and the [supported versions of Ruby on Rails](https://guides.rubyonrails.org/maintenance_policy.html).  We aim to keep our [test configuration](blob/main/.github/workflows/ruby.yml) up to date with these supported versions.\n\n## Contributing Code\n\nCode contributions are always welcome, instructions for contributing can be found at [CONTRIBUTING.md](https://github.com/projectblacklight/blacklight/blob/main/CONTRIBUTING.md).\n\n## Configuring Apache Solr\nYou'll also want some information about how Blacklight expects [Apache Solr](http://lucene.apache.org/solr ) to run, which you can find in [Solr Configuration](https://github.com/projectblacklight/blacklight/wiki/Solr-Configuration#solr-configuration)\n\n## Building the javascript\nThe javascript includes some derivative combination files that are built at release time, that can be used by some javascript pipelines. The derivatives are placed at `app/assets/javascripts/blacklight`, and files there should not be edited by hand.\n\nWhen any of the javascript components in the gem are changed, you may have to rebuild these derivative files.\n\n\n1. [Install npm](https://www.npmjs.com/get-npm)\n1. run `bundle exec rake build:npm`\n  (just runs `npm install` to download dependencies and `npm run prepare` to build the bundle)\n\n\n## Releasing versions\n\nYou always need to release both the rubygem and npm package simultaneously. For more information, see [wiki](https://github.com/projectblacklight/blacklight/wiki/How-to-release-a-version)\n\nSummary of technical steps:\n\n1. Make sure `./package.json` and  `./VERSION` files have correct and matching versions.\n1. Release ruby gem with `bundle exec rake release`\n1. Release npm package\n  1. Build derivative products included in release with `bundle exec rake build:npm`\n  1. Publish with `npm publish`.\n\n\n\n## Using the javascript\nBlacklight ships with Javascript that can be compiled either by Webpacker or by\nSprockets. To use Webpacker see the directions at https://github.com/projectblacklight/blacklight/wiki/Using-Webpacker-to-compile-javascript-assets\n\nIf you prefer to use Sprockets, simply run the install generator, which will run the assets generator. For details see https://github.com/projectblacklight/blacklight/wiki/Using-Sprockets-to-compile-javascript-assets\n","funding_links":[],"categories":["Ruby","ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectblacklight%2Fblacklight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprojectblacklight%2Fblacklight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectblacklight%2Fblacklight/lists"}