Environment Variables

Variables

CodeRoad has a number of configurations:

• CODEROAD_DISPLAY_RUN_TEST_BUTTON - show the "Run" button on the tutorial page. Defaults true.

• CODEROAD_DISABLE_RUN_ON_SAVE - stop running tests whenever a file is saved. Defaults false.

• CODEROAD_TUTORIAL_URL - pass in a url path to a tutorial.json file. The tutorial will launch on startup. This is a way to create one-click tutorial experiences for web or locally. Defaults null.

• CODEROAD_ADMIN_MODE - a mode for tutorial developers. Under the "Review" page, you can jump around between levels & steps to test development. Defaults false.

How to Use Variables

Local

Launch the code editor with the environmental variables.

CODEROAD_ADMIN_MODE=true code .

Note that this requires the VSCode CLI.

Web / Virtual Machine

VSCode can be run in a browser in a variety of ways:

• Code Server
• Codespaces

Read the docs for info on how to pass in variables, or contact coderoadapp@gmail.com for a working example.