FOLIO Developer Curriculum

Getting Started with FOLIO for Developers

00: Introduction
01: Deploy test Stripes module
02: Clone, Build, and Explore Okapi
03: Initialize Okapi from the command line
04: Set up the Okapi Users app

FOLIO Developer Curriculum Outline

This is an outline of a tutorial that can be given to a group in a workshop or followed by an individual developer in a self-paced fashion.


System Requirements

There are two choices: either running the Stripes Development UI Server and the Okapi Gateway directly on a developer’s machine (“on-machine”) or running Stripes and Okapi in a VirtualBox guest. An Ansible playbook with appropriate roles is used to create the VirtualBox guest, and can also be used to automatically build a developer’s environment (making the playbook target localhost).


Before attending the workshop, participants must meet these requirements. When in doubt, using the VirtualBox guest machine is recommended.


(Note that on MacOS these prerequisites can be installed using Homebrew.)

VirtualBox guest

To download the VirtualBox guest:

  1. Make a clean directory and change into it: mkdir folio-curriculum && cd folio-curriculum
  2. Set up the Vagrantfile: vagrant init --minimal folio/curriculum
  3. Launch the VirtualBox guest: vagrant up
  4. Connect to the VirtualBox guest: vagrant ssh


  1. Deploy test Stripes package
  2. Clone, build and explore Okapi
  3. Initialize Okapi Gateway from the command line
  4. Real-world application: set up the FOLIO Users app
  5. Build a skeletal RAML-module-builder module

Run Jekyll Locally

To view the documentation locally:

Additional information

See project FOLIO at the FOLIO issue tracker.

Other FOLIO Developer documentation is at