Relevancy Dashboard

The relevancy dashboard provides a way to visualize document ranking and relevancy differences across different solr configurations.

Requirements

1. Ruby 3.1
2. bundler gem
3. Redis

Installation

Clone the repository

$ git clone [email protected]:sul-dlss/relevancy_dashboard.git

Move into the app, install dependencies, and initialize the database

$ cd relevancy_dashboard
$ bundle install
$ yarn install
$ rails db:migrate

Start the development server

$ bin/dev

Configuring

Configuration is handled through the application.

Testing

The test suite (with RuboCop style enforcement) will be run with the default rake task (also run on travis)

$ bin/rake

The specs can be run without RuboCop style enforcement

$ bundle exec rspec

The RuboCop style enforcement can be run without running the tests

$ bundle exec rubocop

Adding endpoints and searches

Endpoints can be added from the application (/endpoints/new). It should point at the query endpoint (often /select) for a solr core/collection. It is recommended to add at least two endpoints.

Then, different search cases can be added. The query parameters are raw URL parameters (of the form q=xyz&sort=score+asc).