Holiday Extras Partner API Documentation

Overview

Documentation to give to partners who would like to integrate with our API.

Contributing

Installation

Setting up ruby (only need to be done once per machine):

curl -sSL https://get.rvm.io | bash -s stable
rvm install "ruby-3.2.0" --with-openssl-dir=$(brew --prefix openssl@1.1)
gem install bundler

Then finally

bundle install

Running locally

rake start

Then open http://127.0.0.1:4000/.

Testing

rake

Deployment

Merges to master will automatically deploy changes via CI (currently running on github actions).

Please do not modify the docs directory as this will be overwritten by the CI process.