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
To view the documentation locally:
git clone email@example.com/folio-org/curriculum.git folio-curriculum && cd folio-curriculum && bundle install
bundle exec jekyll serve