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.
The FOLIO Developer’s Curriculum is a series of four lessons that can be followed on your own or can form the basis of an instructor-led workshop.
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.
With that background understanding, see the documentation for each server-side module, especially RAML Module Builder (RMB).
The FOLIO user-interface toolkit is called Stripes. It is described in the Stripes Core README, which leads to the related documentation.
With that background understanding, see the documentation for each client-side module, especially the “ui-users”.
The okapi-stripes is a special Okapi module used to generate Stripes-based UIs for individual FOLIO tenants.
Running a complete system
The document Running a complete FOLIO system explains ways to enable a development system running the Okapi gateway, various server-side modules, sample data, and the Stripes UI development server. It goes on to explain another way to configure modules using the Okapi Console front-end.
Use folio-ansible for a quick-start FOLIO installation as a virtual machine using Vagrant and Ansible. This also provides various pre-built “black boxes” including the full “folio-demo” and “folio-backend-auth”. The current built boxes are also available to download from HashiCorp Atlas. The list of module versions for each box is shown in its change-log.
- The set of automatically generated API documentation.
Guidelines, tips, and best practice documents:
- Other community guidelines: Contribution; which communication forum; issue tracker; etc.
- A FOLIO glossary of some terms and technologies used in FOLIO.
- Some tips to assist developers to configure their local workstation setup.
- Some tips to assist developers to conduct troubleshooting.
- Best practices for Dockerfiles.
- The FOLIO build, test, and deployment infrastructure.
- Release procedures.
- A proposal for error response formats.