1. What is Atom-CodeRoad?
Atom-CodeRoad is an Atom plugin that lets you play interactive coding tutorials inside of your Atom editor.
Atom-CodeRoad & Builder-CodeRoad both have several key dependencies before starting:
|NodeJS||>0.10.x||Check your version with
Download the latest from nodejs.org
|NPM||>3.x.x<||Check your version with
NPM comes installed with NodeJS,
and can be updated with
|Atom Editor||>1.6.0||A popular code editor available at Atom.io|
3. Quick Start
To install atom-coderoad, you have two options:
Inside of Atom, select the following menus:
- search for “atom-coderoad”
Use Atom Shell Commands.
> apm install atom-coderoad
Toggle open Atom-CodeRoad using the Packages menu or press ctrl-alt-0.
5. Installing Tutorials
To install a tutorial, setup a package.json file and save the tutorial as a dependency.
You can setup a project quickly by typing
> npm init --y into the command line in your project’s folder. This agrees to all of the defaults for your newly created package.json file.
Now you can install a tutorial. Run
> npm install --save-dev $THE-PACKAGE-NAME$ to save the tutorial as a package development dependency. If you run Atom-CodeRoad you should see the tutorial appear on the tutorial list screen.
If you are stuck at a screen that says ‘install a tutorial’, try updating your version of NPM to 3.x+.
6. Recommended Settings
It’s recommended you also enable autosave in Atom.
Tutorials run unit tests on save, autosave can speed up the process.