- Notifications
You must be signed in to change notification settings - Fork2
CLI for CodeRoad tutorial creation
License
coderoad/coderoad-cli
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Command line interface forCodeRoad.
Use CodeRoad CLI to set up and build a tutorial configuration file.
npm install -g @coderoad/cli
coderoad create
Create templates files in the current folder for the content and setup files.
$ coderoad build [options]options: -g, --git Tutorial's remote git address. Either --git or --dir should be provided. -d, --dir Tutorial's local directory. Either --git or --dir should be provided. -c, --code Branch that contains the code. -s, --setup Branch that contains the TUTORIAL.md and coderoad.yaml files. -o, --output (Optional) Save the configuration in the output file. Log into the console if not set -h, --help (Optional) Show the help messageBuild the configuration file to be used by the extension to run the tutorial. The configuration file is created by matching thelevel andstep ids between theTUTORIAL.md andcoderoad.yaml files against git commit messages with the same ids. For example:
TUTORIAL.md
...##L10 This is a level with id = 10This level has two steps...###L10S1 First stepThe first step with id L10S1. The Step id should start with the level id.###L10S2 The second stepThe second step...
coderoad.yaml
---levels: -id:L10config:{}steps: -id:L10S1setup:files: -package.jsoncommits:[]watchers: -package.json -node_modules/expresscommands: -npm installsolution:files: -package.jsoncommits:[]commands: -npm install -id:L10S2setup:files: -src/server.jscommits:[]commands: -npm installsolution:files: -src/server.jscommits:[]
... and the commit messages
commit 8e0e3a42ae565050181fdb68298114df21467a74 (HEAD -> v2, origin/v2)Author: creator <author@email.com>Date: Sun May 3 16:16:01 2020 -0700 L10S1Q setup step 1 for level 2commit 9499611fc9b311040dcabaf2d98439fc0c356cc9Author: creator <author@email.com>Date: Sun May 3 16:13:37 2020 -0700 L10S2A checkout solution for Level 1, step 2commit c5c62041282579b495d3589b2eb1fdda2bcd7155Author: creator <author@email.com>Date: Sun May 3 16:11:42 2020 -0700 L10S2Q setup level 1, step 2Note that the stepL10S2 has two commits, one with the suffixQ and another one withA. The suffixes meanQuestion andAnswer, respectively.
Steps defined as questions arerequired as they are meant to set the task to be executed by the student. The answer is optional and should be used when a commit must be loaded to verify the student's solution. If there is no need to load commits forA steps, thecommits key should be removed from thecoderoad.yaml file for that step.
IMPORTANT
Only the most recent commit is evaluated for each level/step id.
About
CLI for CodeRoad tutorial creation
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors4
Uh oh!
There was an error while loading.Please reload this page.