{"id":21076323,"url":"https://github.com/coderoad/coderoad-cli-deprecated","last_synced_at":"2025-03-14T03:43:32.246Z","repository":{"id":124243907,"uuid":"50390431","full_name":"coderoad/coderoad-cli-deprecated","owner":"coderoad","description":"CodeRoad CLI - tools to help build tutorial files","archived":false,"fork":false,"pushed_at":"2016-09-17T03:49:14.000Z","size":297,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-20T22:52:58.987Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://coderoad.github.io/docs#install","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coderoad.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-01-26T00:11:49.000Z","updated_at":"2019-09-13T02:52:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"af14cd88-5e3c-4ca8-a094-c32c0bddb38c","html_url":"https://github.com/coderoad/coderoad-cli-deprecated","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderoad%2Fcoderoad-cli-deprecated","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderoad%2Fcoderoad-cli-deprecated/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderoad%2Fcoderoad-cli-deprecated/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderoad%2Fcoderoad-cli-deprecated/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coderoad","download_url":"https://codeload.github.com/coderoad/coderoad-cli-deprecated/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243521251,"owners_count":20304185,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T19:27:51.286Z","updated_at":"2025-03-14T03:43:32.236Z","avatar_url":"https://github.com/coderoad.png","language":"JavaScript","readme":"# CodeRoad CLI\nCommand line interface for [CodeRoad](http://coderoad.github.io). See the [docs](https://coderoad.github.io/tutorial-docs.html) for more.\n\n### Install\n\nUse CodeRoad CLI to setup and build a project data file.\n\nInstall *CodeRoad-CLI*. Make sure [NodeJS](nodejs.org) is already installed\n\n    \u003e npm install -g coderoad-cli\n\n\n### Create\n\nGet setup quickly with CodeRoad: either [clone a tutorial repo](https://git-scm.com/docs/git-clone) or use the *CodeRoad-CLI*.\n\nIn your development directory, run **create** with your new package name.\n\n    \u003e coderoad create $YOUR-PACKAGE-NAME$\n\nRunning **create** generates:\n\n* an example `tutorial.md`, which imports several tutorial files\n* an example `test` directory with a few example tests\n* a `package.json` configuration with some of the following settings:\n\n```json\n{\n  \"name\": \"coderoad-$TUTORIAL-NAME$\",\n  \"version\": \"0.1.0\",\n  \"description\": \"Coderoad tutorial\",\n  \"author\": \"Name \u003cemail\u003e (site)\",\n  \"main\": \"coderoad.json\",\n  \"keywords\": [\"coderoad\", \"tutorial\"],\n  \"dependencies\": {\n      \"mocha-coderoad\": \"0.10.0\"\n  },\n  \"config\": {\n      \"language\": \"JS\",\n      \"dir\": \"tutorial\",\n      \"runner\": \"mocha-coderoad\",\n      \"testSuffix\": \".js\"\n  }\n}\n```\n\nWe'll learn more about these configurations when it's time to [publish](#publish).\n\nUpdate changes to your tutorial by running **build**. This will generate a *coderoad.json* data file used by *atom-coderoad*.\n\n    \u003e coderoad build\n\n\n### Validate\n\nValidate your package.json \u0026 coderoad.json for possible errors or flagged warnings.\n\n    \u003e coderoad validate\n\n\n### Demo Your Tutorial\n\nOpen a new directory for demoing your tutorial. Setup a new NPM project file.\n\n    \u003e npm init\n\nAdd your package name to the `dependencies` in `package.json`:\n\n```json\n{\n  \"dependencies\": {\n      \"coderoad-$YOUR-PACKAGE-NAME$\": \"^0.1.0\"\n  }\n}\n```\n\nNormally 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.\n\n### Link Your Demo \u0026 Tutorial\n\n[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.\n\nInside of your tutorial root directory, run link.\n\n    \u003e npm link\n\nInside of your demo root directory, connect the link.\n\n    \u003e npm link coderoad-$YOUR-PACKAGE-NAME$\n    \u003e npm install\n\n\n### Using Atom\n\nOpen *Atom-Coderoad* to view your tutorial. Your package should appear as a loaded package. Click on it.\n\nReload *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.\n\n* Windows \u0026 Linux: alt-ctrl-r\n* Mac: ctrl-alt-cmd-l\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderoad%2Fcoderoad-cli-deprecated","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderoad%2Fcoderoad-cli-deprecated","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderoad%2Fcoderoad-cli-deprecated/lists"}