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 FOLIO Developer’s Curriculum, which is a series of self-paced or instructor-guided lessons, and 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.

Developer’s curriculum

The FOLIO Developer’s Curriculum is a series of lessons that can be followed on your own or can form the basis of an instructor-led workshop.

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.

Modules

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, especially RAML Module Builder (RMB).

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”.

Guides

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.

Development tips

Tutorials

Development management

Community

Other topics