Repository files navigation

Command line interface forCodeRoad. See thedocs for more.

UseCodeRoad CLI to setup and build a project data file.

InstallCodeRoad-CLI. Make sureNodeJS is already installed

> npm install -g coderoad-cli

Get setup quickly with CodeRoad: eitherclone a tutorial repo or use theCodeRoad-CLI.

In your development directory, runcreate with your new package name.

> coderoad create $YOUR-PACKAGE-NAME$

Runningcreate generates:

• an exampletutorial.md, which imports several tutorial files
• an exampletest directory with a few example tests
• apackage.json configuration with some of the following settings:

{"name":"coderoad-$TUTORIAL-NAME$","version":"0.1.0","description":"Coderoad tutorial","author":"Name <email> (site)","main":"coderoad.json","keywords": ["coderoad","tutorial"],"dependencies": {"mocha-coderoad":"^0.3.1"  },"config": {"dir":"tutorial","runner":"mocha-coderoad","testSuffix":".spec.js"  }}

We'll learn more about these configurations when it's time topublish.

Update changes to your tutorial by runningbuild. This will generate acoderoad.json data file used byatom-coderoad.

> coderoad build

Validate your package.json & coderoad.json for possible errors or flagged warnings.

> coderoad validate

Open a new directory for demoing your tutorial. Setup a new NPM project file.

> npm init

Add your package name to thedependencies inpackage.json:

{"dependencies": {"coderoad-$YOUR-PACKAGE-NAME$":"^0.1.0"  }}

Normally you would usenpm install to install the package, but your package isn't ready to be published yet. Instead, you need to link your tutorial package to your demo directory.

NPM link creates a symbolic link between directories. This allows your demo directory to always load your tutorial package.

Inside of your tutorial root directory, run link.

> npm link

Inside of your demo root directory, connect the link.

> npm link coderoad-$YOUR-PACKAGE-NAME$> npm install

OpenAtom-Coderoad to view your tutorial. Your package should appear as a loaded package. Click on it.

ReloadAtom to view changes. 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