Skip FOLIO Project Navigation

Documentation for the various components of FOLIO is in continuous development. Since the system is composed of many separate components, each component is documented individually. The best places to start are the early chapters of the Okapi Guide and Reference, which describe the system as a whole and explain how the parts fit together.

In the context of those early chapters, you may then wish to go on to:

Community and contribution

The community section explains how to be involved, provides the contribution guidelines, lists the various collaboration tools and has some recommendations about when to use each.

Core code

The most important technical document is the Okapi Guide and Reference, which after the introductory sections already described, goes into detail about the Okapi API Gateway that controls a FOLIO system.


The FOLIO-Sample-Modules guide contains an explanation of FOLIO modules, a “getting started” guide, and some sample module code. Follow on to the specific documentation for each of those modules.

With that background understanding, see the documentation for each server-side module.

User Interface

The FOLIO user-interface toolkit is called Stripes. It is described in the Stripes README, which leads to the related documentation.

With that background understanding, see the documentation for each client-side module, especially the “ui-users”.


Background orientation

Refer to the Guidelines section.

Other orientation guides:

Setup and configuration

Getting started

Refer to the Start section.

Reference documentation

Fundamental documentation

These are listed in the Start section.

Module development bases

There are various libraries and frameworks that provide the basis for module development.

Front-end module basis

FOLIO Stripes is the basis for front-end module development. This is introduced at the Primer for front-end development.

Back-end module bases

For back-end module development there are various options. These are introduced at the Primer for back-end development.

Some more detail is provided via other introductory documentation:

  • The FOLIO Spring-Way Framework is the recommended approach for development of FOLIO modules using the Spring framework and Spring projects and OpenAPI (OAS).
  • The FOLIO Vert.x library is a lightweight FOLIO module development library for Vert.x that supports OpenAPI (OAS). It is the recommended library for development of FOLIO modules with Vert.x OpenAPI.
  • The RAML Module Builder (RMB) framework, is a special FOLIO module using RAML that abstracts much functionality and enables the developer to focus on implementing business functions. It also exposes a Vert.x based runtime library. Note: RAML Module Builder is no longer being extended with new functionality and is in maintenance mode only.

Development tips


Development management

Development operations

For people assisting with the FOLIO development operations infrastructure (DevOps), there are various notes. For example regarding operation, enhancement, and configuration of Jenkins continuous integration.


Other topics


Brief explanations of various topics.