ROAR developer's guide¶
Write your own ROAR assessment
The ROAR app development guide provides documentation for developers of ROAR assessments. The guide will take you step-by-step through the process of writing your own ROAR app in which participants will identify images representing hot dogs and "not hot dogs." Please see the Contributing Guide for information on contributing to the create-roar-app initializer or to the developer guide itself. You can jump directly to a page listed below, or use the next and previous buttons in the navigation bar at the top of the page to move through the documentation in order.
- Folder Structure
- Writing Your Experiment
- Installing Additional Dependencies
- Deploying Your Experiment
- Retrieving Data
You may also find it helpful to review some ROAR terminology. You can also browse the "Common Issues" section in the sidebar to the left to see solutions to common issues that ROAR developers face.
This guide uses screencasts
Throughout this guide, you will see screencasts like the one below
As mentioned in the screencast, you can copy text directly from the screencast. These screencasts are made using asciinema.
In the screencasts, you might see us using the micro text editor. We chose that because it's a terminal-based text editor that plays nicely with the screencasting software that we use in this guide. You should use whatever text editor you are already comfortable with. If you don't already have a favorite text editor, we recommend VS Code.