Formerly known as MARC Liberation (since it liberates MARC data from Voyager).
Find Internal Documentation on our confluence wiki
- Postgresql (provided in development by lando)
brew install lastpass-cli
brew install shared-mime-info
(formimemagic
gem)
Note: You need to have PostgreSQL installed in your machine and available in your path for the pg
gem to compile native extensions (e.g. export PATH=$PATH:/Library/PostgreSQL/10/bin/
).
- Install Lando from lando releases GitHub (at least 3.0.0-rrc.2)
- Install Sidekiq Pro credentials:
lpass login emailhere
bin/setup_keys
- Install bundler version in Gemfile.lock
gem install bundler -v '2.2.27'
- Install bundle
bundle install
- To start:
bundle exec rake servers:start
- For testing:
bundle exec rspec
- For development:
bundle exec rails server
- Access bibdata at http://localhost:3000/
- If you will be working with background jobs in development, include your netid so you are recognized as an admin
BIBDATA_ADMIN_NETIDS=yournetid bundle exec rails server
- If you are working with background jobs in development, start sidekiq in a new tab or window
bundle exec sidekiq
- To access the sidekiq dashboard, first sign into the application, then go to http://localhost:3000/sidekiq
- To stop:
bundle exec rake servers:stop
orlando stop
lpass login emailhere
bundle exec rake alma:setup_keys
This will add a .env with credentials to Rails.root
In order to resolve bibliographic identifiers (bib. IDs) to resources with ARKs and IIIF manifests for resources managed within digital repositories, caches are seeded and used in order to resolve the relationships between these resources.
One may seed the cache using the following Rake Task:
rake liberate:arks:seed_cache
In development, when running commands that utilize the cache, such as commands indexing via traject, set the FIGGY_ARK_CACHE_PATH
to point to spec/fixtures/marc_to_solr/figgy_ark_cache
in the local environment.
export FIGGY_ARK_CACHE_PATH=spec/fixtures/marc_to_solr/figgy_ark_cache
One may clear the cache using the following Rake Task:
rake liberate:arks:clear_cache
Ensure redis is running
To run the tests in the marc_to_solr
directory set RAILS_ENV:
$ RAILS_ENV=test bundle exec rspec spec/marc_to_solr
To run all the tests use the rake task, which sets some environment variables for you:
$ rake spec
This repository uses semgrep to:
- Guard against common gotchas within bibdata
- Perform static security analysis
To run semgrep locally:
brew install semgrep
semgrep --config .semgrep.yml . # run custom bibdata rules
semgrep --config auto . # run rules from the semgrep community
semgrep --config auto --config .semgrep.yml . # run both sets of rules
Deployment is through capistrano. To deploy a branch other than "main", prepend an environment variable to your deploy command, e.g.:
BRANCH=my_feature bundle exec cap staging deploy
See: Location Changes documentation
see [[webhook_monitor/README.md]]
See LICENSE
.