Repository files navigation

Interactive coding tutorials inside of the Atom editor. Learn more atcoderoad.io.

** Currently beta. Post issues. **

UseAtom CodeRoad to view and play your tutorial

• Download theAtom editor

• Install theAtom-CodeRoad package, or use theapm command-line tool

  > apm install atom-coderoad

• OpenAtom-CodeRoad inAtom using the "packages" menu or pressctrl-alt-1.

• It's recommended you also enable Autosave in Atom.

To enable autosave in Atom, go toAtom >Preferences >Packages > search for"autosave" >settings > check"enabled".

• If CodeRoad is unavailable underAtom >Packages >CodeRoad, restart or reload atom.

You can use the Atomcommand-palette to find "reload" or simply use the reload hot-key.

• Windows & Linux: alt-ctrl-r
• Mac: ctrl-alt-cmd-l

To install a tutorial, setup apackage.json file and save the tutorial as a dependency. Make sureNodeJS is already installed.

You can setup a project quickly by typingnpm init --y into the command line in your project's folder. This agrees to all of the defaults for your newly createdpackage.json file.

Now you can install a tutorial. Runnpm install --save-dev $THE-PACKAGE-NAME$ to save the tutorial as a package development dependency. If you runAtom-CodeRoad you should see the tutorial appear on the first screen.