Home

The Supplejack API is a mountable engine which provides functionality to store, index and retrieve metadata via an API.

This wiki provides a guide on how to create and configure your API as well as an introduction to the rest of the Supplejack project.

Getting started

Before starting you should check that you have all the dependancies installed.

Once that is complete we strongly recommend using the Supplejack template to create your app. This template will create a new app which includes the Supplejack API engine and then step through the configuration options. To install using the template simply run the following command from the command line

rails _3.2.12_ new mysupplejack_api -m https://raw.github.com/digitalnz/supplejack_template/master/template.rb

Once the install is complete you should have a working API. The next step is to configure your schema so that you can configure the fields that are stored/returned by your API.