https://github.com/psu-libraries/psulib_blacklight
Penn State University Libraries' Blacklight Catalog
https://github.com/psu-libraries/psulib_blacklight
ruby ruby-on-rails solr
Last synced: 3 months ago
JSON representation
Penn State University Libraries' Blacklight Catalog
- Host: GitHub
- URL: https://github.com/psu-libraries/psulib_blacklight
- Owner: psu-libraries
- License: apache-2.0
- Created: 2018-09-21T15:54:57.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2026-02-16T05:51:35.000Z (4 months ago)
- Last Synced: 2026-02-16T09:40:36.034Z (4 months ago)
- Topics: ruby, ruby-on-rails, solr
- Language: mIRC Script
- Homepage:
- Size: 16.1 MB
- Stars: 9
- Watchers: 5
- Forks: 3
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://codeclimate.com/github/psu-libraries/psulib_blacklight/maintainability) [](https://codeclimate.com/github/psu-libraries/psulib_blacklight/test_coverage)
The Penn State University Libraries' catalog. Built on Blacklight, using Traject for ingesting binary marc.
# Software Dependencies
| Software | Version |
|-----------|---------|
| `ruby` | 3.4.1 |
| `rails` | 7.1.4 |
| `solr` | 9.6.1 |
## When upgrading Blacklight
Because we use shakapacker, when upgrading the Blacklight gem for this application, we should also update `package.json`
to the same version as the installed gem so as to keep these things in step from Blacklight.
## Development
See [Development Setup](https://github.com/psu-libraries/psulib_blacklight/wiki/Development-Setup)
# Application notes
## "Blackcat Admin" feature
The [config](https://rubygems.org/gems/config) gem provides a means for adding ad-hoc config as needed. The file
`config/settings.local.yml` is not tracked in git. So far 5 settings have been added:
1. Modify the announcement bar (thin bar at top)
1. Put the site in "readonly" (no availability data)
1. Put holds in readonly mode by hiding the I Want It button
1. Modify the hold button url
Here is a sample of what the `settings.yml` file might look like:
```rb
# Strings
announcement:
# See https://fontawesome.com/icons
icon: fa-exclamation-circle
message: All University Libraries locations are closed, but we're here to help! See University Libraries COVID-19 (novel coronavirus) Updates and Resources for more information.
# See https://getbootstrap.com/docs/4.4/utilities/colors/
html_class: bg-warning
my_account_url: https://myaccount.libraries.psu.edu/
hold_button_path: holds/new?catkey=
no_recall_button_path: ill/new?catkey=
# Booleans
readonly: false
hide_hold_button: false
hide_announcement: false
```
If one of the special keys isn't present, there is no ill-effect. It is just not there and the system operates as per
usual. If the announcement array isn't present, then the default announcement in the translation file will show.