
Okapi — a multitenant API Gateway
=================================

Copyright (C) 2016 The Open Library Foundation

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

System requirements
-------------------

The Okapi software has the following compile-time dependencies:

* Java 8

* Apache Maven 3.3.x or higher

In addition, the test suite must be able to bind to ports 9130-9134 to succeed.

*Note: If tests fail, the API Gateway may be unable in some cases to shut down
microservices that it has spawned, and they may need to be terminated
manually.*

Quick start
-----------

To build and run:

    $ mvn install
    $ mvn exec:exec

Okapi listens on port 9130.

Documentation
-------------

* [Okapi Guide and Reference](doc/guide.md)
* [Contributing guidelines](CONTRIBUTING.md)
* Other documentation at [dev.folio.org](http://dev.folio.org/)


Okapi — a multitenant API Gateway
=================================

Copyright (C) 2016 The Open Library Foundation

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

System requirements
-------------------

The Okapi software has the following compile-time dependencies:

* Java 8

* Apache Maven 3.3.x or higher

In addition, the test suite must be able to bind to ports 9130-9134 to succeed.

*Note: If tests fail, the API Gateway may be unable in some cases to shut down
microservices that it has spawned, and they may need to be terminated
manually.*

Quick start
-----------

To build and run:

    $ mvn install
    $ mvn exec:exec

Okapi listens on port 9130.

Documentation
-------------

* [Okapi Guide and Reference](doc/guide.md)
* [Contributing guidelines](CONTRIBUTING.md)
* Other FOLIO Developer documentation is at [dev.folio.org](http://dev.folio.org/)

Improve link to FOLIO Developer docs
Improve link to FOLIO Developer docs

FOLIO-357
