PURL
PURL service is a URL resolver that translates a reference to a digital object (in the form of a druid
), into a full content representation of that object as available in public access environment
Please create a github release before deploying.
Requirements
- Ruby (3.1 or greater)
- bundler gem
Installation
Clone the repository
$ git clone git@github.com:sul-dlss/purl.git
Move into the app and install dependencies
$ cd purl
$ bundle install
Start the development server
$ bin/dev
Configuring
Configuration is handled through the RailsConfig settings.yml files.
Local Configuration
The defaults in config/settings.yml
should work on a locally run installation.
Testing
The test suite (with RuboCop style enforcement) will be run with the default rake task (also run on travis)
$ rake
The specs can be run without RuboCop style enforcement
$ rake spec
The RuboCop style enforcement can be run without running the tests
$ rake rubocop
Deploying
Please create a github release before deploying to production.
Capistrano is used for deployment
$ cap dev deploy