https://github.com/coderoad/coderoad-cli-deprecated
CodeRoad CLI - tools to help build tutorial files
https://github.com/coderoad/coderoad-cli-deprecated
Last synced: 9 months ago
JSON representation
CodeRoad CLI - tools to help build tutorial files
- Host: GitHub
- URL: https://github.com/coderoad/coderoad-cli-deprecated
- Owner: coderoad
- License: apache-2.0
- Created: 2016-01-26T00:11:49.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-09-17T03:49:14.000Z (about 9 years ago)
- Last Synced: 2025-01-20T22:52:58.987Z (11 months ago)
- Language: JavaScript
- Homepage: https://coderoad.github.io/docs#install
- Size: 290 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CodeRoad CLI
Command line interface for [CodeRoad](http://coderoad.github.io). See the [docs](https://coderoad.github.io/tutorial-docs.html) for more.
### Install
Use CodeRoad CLI to setup and build a project data file.
Install *CodeRoad-CLI*. Make sure [NodeJS](nodejs.org) is already installed
> npm install -g coderoad-cli
### Create
Get setup quickly with CodeRoad: either [clone a tutorial repo](https://git-scm.com/docs/git-clone) or use the *CodeRoad-CLI*.
In your development directory, run **create** with your new package name.
> coderoad create $YOUR-PACKAGE-NAME$
Running **create** generates:
* an example `tutorial.md`, which imports several tutorial files
* an example `test` directory with a few example tests
* a `package.json` configuration with some of the following settings:
```json
{
"name": "coderoad-$TUTORIAL-NAME$",
"version": "0.1.0",
"description": "Coderoad tutorial",
"author": "Name (site)",
"main": "coderoad.json",
"keywords": ["coderoad", "tutorial"],
"dependencies": {
"mocha-coderoad": "0.10.0"
},
"config": {
"language": "JS",
"dir": "tutorial",
"runner": "mocha-coderoad",
"testSuffix": ".js"
}
}
```
We'll learn more about these configurations when it's time to [publish](#publish).
Update changes to your tutorial by running **build**. This will generate a *coderoad.json* data file used by *atom-coderoad*.
> coderoad build
### Validate
Validate your package.json & coderoad.json for possible errors or flagged warnings.
> coderoad validate
### Demo Your Tutorial
Open a new directory for demoing your tutorial. Setup a new NPM project file.
> npm init
Add your package name to the `dependencies` in `package.json`:
```json
{
"dependencies": {
"coderoad-$YOUR-PACKAGE-NAME$": "^0.1.0"
}
}
```
Normally you would use `npm 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.
### Link Your Demo & Tutorial
[NPM link](https://docs.npmjs.com/cli/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
### Using Atom
Open *Atom-Coderoad* to view your tutorial. Your package should appear as a loaded package. Click on it.
Reload *Atom* to view changes. You can use the Atom [command-palette](https://atom.io/docs/latest/getting-started-atom-basics#command-palette) to find "reload" or simply use the reload hot-key.
* Windows & Linux: alt-ctrl-r
* Mac: ctrl-alt-cmd-l