CodeRoad VSCode

CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor.

Getting Started

Start

To start the extension, inside VSCode:

• open an empty VSCode workspace (an empty folder)
• launch the app from the VSCode command palette:
  • select “View” > “Command Palette” from the top panel OR press cmd/ctrl + shift + P
  • in the command palette, search for and run CodeRoad:Start
• a webview should appear on the right side of your editor. Click "Start"

Install

Install CodeRoad from this link in the VSCode Marketplace.

• You may need to reload the window (ctrl/cmd + R)
• See "Start" to get started.

Requirements

• OS: MacOS, Windows, Linux
• VSCode 1.39.2+
• Node.js 10+
• Git

Creating Tutorials

Build and share your own interactive tutorials.

Learn more about how tutorials area created.

See an interactive visualization of a tutorial repository.

Editing Tutorials

Tutorials can be edited directly as markdown on Github.

Development

To run the extension locally:

• copy environmental variables from /web-app/.env.example as /web-app/.env
• install dependencies with yarn install-all
• build the extension with yarn build
• open the extension with the vscode extension debugger by pressing F5. In the new window, open CodeRoad.

To test a packaged build locally:

• if on Mac, ensure you have VSCode command line tools installed
• run yarn package. It will build the extension and install it locally.
• open a new vscode window and launch the new version of CodeRoad

Contributing

CodeRoad is an ambitious project, we're always looking for contributors :)

See CONTRIBUTING.md.

License

AGPL v3