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.
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.)
To download the VirtualBox guest:
mkdir folio-curriculum && cd folio-curriculum
vagrant init --minimal folio/curriculum
In subsequent lessons, the command lines are executed within the VirtualBox guest.
Be sure you are connected to the VirtualBox guest (from the host computer:
vagrant ssh) before running the commands.
Other instructions and commands that are specific to the VirtualBox guest mode of using the tutorial are noted using this style of information box.
If launching Vagrant from a Windows Command Prompt, be sure to use Run As Administrator… when opening the Command Prompt itself (
cmd.exe). If you are seeing the error “EPROTO: protocol error, symlink”, the likely cause is that Vagrant was not launched with administrator privileges. See issue STRIPES-344 for details.
FOLIO_ROOTVariable for Lessons
Each lesson assumes the existence of a
$FOLIO_ROOT shell variable.
This variable holds the path to a directory where the components of the Okapi Server and the Stripes Development UI Server are located.
If using the VirtualBox guest setup, it is recommended to first
cd /vagrant before creating the empty directory. Doing so makes the Okapi and Stripes files available from the host operating system in the same directory the Vagrantfile file is located.
The first command below connects from the VirtualBox host to the VirtualBox guest.
The second command changes the working directory to the shared
$ vagrant ssh $ cd /vagrant
Create the directory, enter the directory, and save the directory location using these commands:
$ mkdir folio-tutorial-working-files $ cd folio-tutorial-working-files $ export FOLIO_ROOT=`pwd`
To view the documentation locally:
git clone firstname.lastname@example.org/folio-org/curriculum.git folio-curriculum && cd folio-curriculum && bundle install
bundle exec jekyll serve
Other FOLIO Developer documentation is at dev.folio.org