mod-circulation

Copyright (C) 2017 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Goal

FOLIO compatible circulation capabilities, including loan items from the inventory.

Prerequisites

Required

• Java 8 JDK
• Gradle 3.3
• FOLIO Loan Storage Module

Optional

• Node.js 6.4 (for API linting)
• NPM 3.10 (for API linting)

Preparation

Git Submodules

There are some common RAML definitions that are shared between FOLIO projects via Git submodules.

To initialise these please run git submodule init && git submodule update in the root directory.

If these are not initialised, the inventory-storage module will fail to build correctly, and other operations may also fail.

More information is available on the developer site.

Common activities

Running a general build

In order to run a general build (including the default tests), run gradle build.

Creating the circulation module JAR

In order to build an executable Jar (e.g. for Okapi to deploy), run gradle fatJar.

Running the tests

Using a fake loan storage module

In order to run the tests, using a fake loan storage module, run ./quick-test.sh.

Using a real loan storage module (via Okapi)

In order to run the tests against a real storage module, run ./real-storage-module-test.sh.

This requires Okapi to be running and an loan storage module be registered with it.

The test script will create a tenant and activate the module for that tenant.

Checking the RAML and JSON.Schema definitions

run ./lint.sh to validate the RAML and JSON.Schema descriptions of the API (requires node.js and NPM)