{"_id":"@akitecht/workshopper","_rev":"3-a37c01c00075190ba57ee57e2a8112d0","name":"@akitecht/workshopper","dist-tags":{"latest":"0.5.1"},"versions":{"0.0.1":{"name":"@akitecht/workshopper","version":"0.0.1","description":"CLI utility that aids in running interactive workshops by providing a nice user experience encapsulating your workshop's code base.","bin":{"workshopper":"./bin/index.js"},"main":"./bin/index.js","repository":{"type":"git","url":"git+ssh://git@github.com/samuelkubai/workshopper.git"},"author":{"name":"Samuel Kubai Kamau","email":"samuel.kubai@andela.com"},"license":"MIT","dependencies":{"@octokit/rest":"^15.16.1","colors":"^1.3.2","commander":"^2.19.0","inquirer":"^6.2.0","marked":"^0.5.1","marked-terminal":"^3.1.1","shelljs":"^0.8.2"},"bugs":{"url":"https://github.com/samuelkubai/workshopper/issues"},"homepage":"https://github.com/samuelkubai/workshopper#readme","directories":{"lib":"lib"},"devDependencies":{},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["node-js","workshops","cli"],"gitHead":"91e85f15392b7204350ac42af7545947ac565e3a","_id":"@akitecht/workshopper@0.0.1","_npmVersion":"6.4.0","_nodeVersion":"10.6.0","_npmUser":{"name":"akitecht","email":"kamausamuel11@gmail.com"},"dist":{"integrity":"sha512-RzmzCAyBwJ61H/kKmQib6IHStzPVnA3gA7T+lN802wHPwI/rMpw17By2Hx8wXJf7+Q1FtYExniHRA1NzI3M1Jg==","shasum":"03d0ef43a4e87fb1c1d69b26010516e08e58e05b","tarball":"https://registry.npmjs.org/@akitecht/workshopper/-/workshopper-0.0.1.tgz","fileCount":12,"unpackedSize":31442,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJb5tE7CRA9TVsSAnZWagAAKBIP/1EwqSgLnvEBW5zh+P0g\nS7fpVg8di6zgS4KruTStrxSbNcHlsBOuJ63kwReccC5gBqLm6B3/Ue1quv0i\nEf6qtpylxzQA7cwmQ2N9+ZzdO2p/sInhueSMEZwJBuqOQzy1NUB52J2hnEvw\nw4NrMlZHcEqfrXpbWtlcd4jRQYhPY6xLVS2pcfzrnNTcKYmagfuafa0ZhJAJ\nc0xm4rA2jio5ulnfanBeiLCgkx3Klk+v0vwPgWqnWP4VttWzywNTQLfjCNM8\nDxsSjg4wHBTeE5sxmqOB+rO1MTcZToEBKDi8QxFArEItXao+vZm/jZT9c7Jg\nQ3ohK7fC1sNfP7jGXzGpnJqSWU04e2el6v0ai8YlbqbjFdD23/h+l2YWWXfV\nllV26J4DrIumIMBXn6jzgqyHzoFv9a57q4cvF4qmJVvkEAYBJ7+1DRK2z6PY\nJ335FqeeVdHIpswaU50IdpqvyMWwjI9tgrDGcKvZ8n7sWnQZrYRTWJRyDkyl\n60Qex8eV5zs7AOIgCtSI9V18IPs73nuZAL6yUR7MAhSbr/NRPhWX3vLNNBSs\nkEqMzXrxKXZTUMdMItSYmySOxP9EyWebGkbR0D7eHPtvXMiThfjzCyXZKOt4\nz5H5NUagY2OYVzRmiTLOR55Rc9PhX9FWiEBx3lNmstNRXEhToXkYFNWQBDzQ\nzD3k\r\n=JJRU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCUf5GeZlHmW8K6bSbcdeSrlZzjc7vMoCDnuhL5wzoqBQIhAJP4fUsCvhKVzrd4gGzD+N2Rse63Ca09eYMSduxm4txd"}]},"maintainers":[{"name":"akitecht","email":"kamausamuel11@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/workshopper_0.0.1_1541853498688_0.3160832580898669"},"_hasShrinkwrap":false},"0.5.0":{"name":"@akitecht/workshopper","version":"0.5.0","description":"CLI utility that aids in running interactive workshops by providing a nice user experience encapsulating your workshop's code base.","bin":{"workshopper":"./bin/index.js"},"main":"./bin/index.js","repository":{"type":"git","url":"git+ssh://git@github.com/samuelkubai/workshopper.git"},"author":{"name":"Samuel Kubai Kamau","email":"samuel.kubai@andela.com"},"license":"MIT","dependencies":{"@octokit/rest":"^15.16.1","colors":"^1.3.2","commander":"^2.19.0","inquirer":"^6.2.0","marked":"^0.5.1","marked-terminal":"^3.1.1","shelljs":"^0.8.2"},"bugs":{"url":"https://github.com/samuelkubai/workshopper/issues"},"homepage":"https://github.com/samuelkubai/workshopper#readme","directories":{"lib":"lib"},"devDependencies":{},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["node-js","workshops","cli"],"gitHead":"0bb0ce96cd08c085a3c60c85d27e3d8dffdb7553","_id":"@akitecht/workshopper@0.5.0","_npmVersion":"6.4.1","_nodeVersion":"10.6.0","_npmUser":{"name":"akitecht","email":"kamausamuel11@gmail.com"},"dist":{"integrity":"sha512-P9je1gPuiwx4Duh/YGjdNYibYkIS7tbLAdKPa7yy6a0312EHpnMuWtZeHUCa4i8Ulrppk9Gh2h4w+VdUiqLukA==","shasum":"a3bcdbd4372e5e184a9529993fbac105a4033bbe","tarball":"https://registry.npmjs.org/@akitecht/workshopper/-/workshopper-0.5.0.tgz","fileCount":12,"unpackedSize":31446,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJb5tTUCRA9TVsSAnZWagAAijEP/1QpNJgaGp7xab1pG4RZ\nElKectLXor0erYRR9nNvZock2/jIbMQC8QTdTqrs33j6erLxIdtF8XKFVlfB\nwL830GOKTVh3hH8r6OIezjhmB8pYq6o4daI3XUZSI9WdKJiH8IoOXaB8hnue\nsZ8tLRlcqYwciRwVAoFGgJx7KUFPOKM5iPw55VBZkIXX/2BxFwlZSLl3Gzkx\n0B7/Dk4YT/RdFtbLcDP6qMhX+vrAtm0ZVMkTs72yql22ejl6W9/r6/qPK7eV\nZI0pmsf2X+u8T3/v4bIjCiPuBHUTzIQk5QLN6lVcjuT+BPyJ9kZIxxSwiVSB\nk99NdNVx3yh/CrgYrgCFbJPr619iPdCygtGMfBM7eJWI/tqV5S6OOn7WsAjQ\nkd757WLX/kkuygetbsj+Cv7IQUJl1ComG99QrCY4mY3YzT5FfzGUUD+cdtk0\nXMA6NmOI8iB8+tyalzCZuImTF+8w7P6deh3nWHi3C0pUOVsLqqZYbiFxfXgc\n6XJ6whYtnkjufiDZnig8PYleliRRVzWRuuaWcuAEMHPmAuPZGEPmauWREP5H\n0VfwDUhdb3/oDzcQkmSDQ+cA+oghy13NTYppI2gt79qKJvUaQ2GtwaJE05bF\nUkAQYTMxtp5rteMHI5Lj+53yTQdgDQ/FLZSgEXCfelMkPqdG/VmSrAWD4dYS\nlQvr\r\n=rjmu\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHv7B8r1PqbeQuRz09x8f10zkuy6hJlSb9spUamdx/rfAiB1qAANNdOHF/UtFzK07XZBgu2SCZ5DDfJwy4kNhICWIg=="}]},"maintainers":[{"name":"akitecht","email":"kamausamuel11@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/workshopper_0.5.0_1541854420158_0.8651280260407244"},"_hasShrinkwrap":false},"0.5.1":{"name":"@akitecht/workshopper","version":"0.5.1","description":"CLI utility that aids in running interactive workshops by providing a nice user experience encapsulating your workshop's code base.","bin":{"workshopper":"./bin/index.js"},"main":"./bin/index.js","repository":{"type":"git","url":"git+ssh://git@github.com/samuelkubai/workshopper.git"},"author":{"name":"Samuel Kubai Kamau","email":"samuel.kubai@andela.com"},"license":"MIT","dependencies":{"@octokit/rest":"^15.16.1","colors":"^1.3.2","commander":"^2.19.0","inquirer":"^6.2.0","marked":"^0.5.1","marked-terminal":"^3.1.1","shelljs":"^0.8.2"},"bugs":{"url":"https://github.com/samuelkubai/workshopper/issues"},"homepage":"https://github.com/samuelkubai/workshopper#readme","directories":{"lib":"lib"},"devDependencies":{},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["node-js","workshops","cli"],"gitHead":"2cd4dca4c02dbb276a9499c92bf8d46b5d6f290b","_id":"@akitecht/workshopper@0.5.1","_npmVersion":"6.4.1","_nodeVersion":"10.6.0","_npmUser":{"name":"akitecht","email":"kamausamuel11@gmail.com"},"dist":{"integrity":"sha512-oghJfU4/8gPWrrluIccdGyPwYMQBCiunYdHuEFbqCzdUloBv8IjsDqulYKjHRzNem6mj4S9U/4Cj1I857FDeLw==","shasum":"a56ac301398c5073e0ed4bf584e0a39fc52a16ca","tarball":"https://registry.npmjs.org/@akitecht/workshopper/-/workshopper-0.5.1.tgz","fileCount":12,"unpackedSize":31478,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJb5vzgCRA9TVsSAnZWagAAI8EQAIcMfBmkfMsWkc/BSbGT\nd4WSKPs/VhuZA7lneiB3cBzLDG4eQ6dwWBgbOEKFYeSXFFm9hS82iJ1tGVFb\nNgUVmfan6AtTQmPS8Ltoh4/mU6G+d7RutMdo50IFyTCqvD+t0k3hq0q87rAX\nIJCWEztT+QSN6XVcE+cVklwl0jOXOPSgnWUHwmLVb0sqUUcSK35WTmrSgnWs\naqtar3YZS1GXLkzoI7fJ+fNWUB/gxQFBqibf/h6/e78UyTy/EqifEDKAyhzf\nZQCBcMN4xCDJCgKu0bv1g4EtTEje1h+Z4IDDmUrqDANGajEMgs5igpQTYdfc\n7XQevWdG1JR+xece6iByDeC+hnFtJqL8HPkph0hl3u5IETij5WGP8244YbZw\n66oQdWDM1dxkHMmm+y1bvuhloXTuVbITjwLPQP+b+O0EovpGnC7xMY6QQMt5\n9+ojMgFLoVAC8RwbLJk4SngCfw4dtQo5S6x1VQJelMXfRyvQaBjKEGomvHoT\nmb5K7fA1iuTCl4IbK0PE0e/Y2xJFDvnFD9kt0qVWYKu5atamQCY/P0hUlARg\nNfH0AuMWx378/4UfJHbF7GRY9fYFoAhm7GwBc6toD6tvKo34/Z64fvBCul5J\neHGzJzjMaH8EoUpHjtEEYDPMJV4JQ0CuXet809L22z7T8fCe3Xopyv/A4cmN\nhZxT\r\n=5cb9\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBlP8BUVGyQ+3uhGwwDsZbWg31OYX4PXaPRVyFpEKh+rAiBQZX5ptQYlNHcYfqRUxiKptAkiVR55zN00jFO0SvsrHQ=="}]},"maintainers":[{"name":"akitecht","email":"kamausamuel11@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/workshopper_0.5.1_1541864671644_0.5021222912262915"},"_hasShrinkwrap":false}},"time":{"created":"2018-11-10T12:38:18.512Z","0.0.1":"2018-11-10T12:38:18.904Z","modified":"2022-04-04T12:29:55.790Z","0.5.0":"2018-11-10T12:53:40.453Z","0.5.1":"2018-11-10T15:44:31.792Z"},"maintainers":[{"name":"akitecht","email":"kamausamuel11@gmail.com"}],"description":"CLI utility that aids in running interactive workshops by providing a nice user experience encapsulating your workshop's code base.","homepage":"https://github.com/samuelkubai/workshopper#readme","keywords":["node-js","workshops","cli"],"repository":{"type":"git","url":"git+ssh://git@github.com/samuelkubai/workshopper.git"},"author":{"name":"Samuel Kubai Kamau","email":"samuel.kubai@andela.com"},"bugs":{"url":"https://github.com/samuelkubai/workshopper/issues"},"license":"MIT","readme":"# Workshopper\n\nWorkshopper is a workshop utility that aids in running interactive workshops by providing\na nice user experience encapsulating your workshop's code base.\n\n## Vision\nThe future of the workshopper application is have a utility anyone can install and pull in from a vast pool of workshops\nbuilt to support the workshopper. The workshopper allows not only for a unified experience of your audience but also\nthe ability for your audience to YOYO (You own your own) their learning after the workshop is done.\n\n## Installation\nThe workshopper is a NPM package you just install globally on your machine.\n\n> Ensure you have either NPM or Yarn is installed on your computer.\n\nFor npm users to install worshopper, run:\n\n```bash\nnpm install -g @akitecht/workshopper\n```\n\nFor yarn users to install workshopper, run:\n\n```bash\nyarn add --global @akitecht/workshopper\n```\n\n## Using workshopper\nOnce you have workshopper installed on your computer globally, you can now pull in any workshop and start off.\n\n### Installing a new workshop\nTo install a new workshop you need the _github_ url of the repo and run the following command:\n\n```bash\nworkshopper start [GITHUB_URL]\n```\n\n### List out the chapters of the workshop\nTo list our the chapters of the workshop, run:\n\n```bash\nworkshopper chapters\n```\n\n### Open a specific chapter\nTo open a specific chapter of the workshop, run:\n\n```bash\nworkshopper open [CHAPTER]\n```\n> The chapter name reference here can be retrieved from the list of chapters\n\n### Run your submission\nTo run your submission for an excercise in the workshop, run:\n\n```bash\nworkshopper run [SUBMISSION_FILE]\n```\n\n### Verify your submission\nTo verify your submission for an excercise in the workshop, run:\n\n```bash\nworkshopper verify [SUBMISSION_FILE]\n```\n\n## Example user journey\nHere is an example journey for a user using workshopper.\n\n> The user here has yarn installed but you can always use npm, refer to the installation instructions for npm installation.\n\n```bash\n\n# Install the workshopper globally\nyarn add --global workshopper\n\n# Pull in your workshop\nworkshopper start https://github.com/samuelkubai/react-testing-workshop\n\n# List out the various chapters for the workshop\nworkshopper chapters\n\n# Select a specific chapter of the workshop\nworkshopper open hi-to-the-console\n\n# Run your submission to see it's outputs\nworkshopper run example-file.js\n\n# Verfiy your submission\nworkshopper verify example-file.js \n\n```\n\n## Building for the workshopper\nTo configure your workshop to be compatible with the workshopper, your workshop requires\n\n**1. Branches**\nChapters in the workshopper are defined by the branches of the repository, so be purposeful about the branch naming as that\nwill be the name for the various chaptes for you workshop.\n\n**2. Make _start_**\nFor each branch on your workshop you need to support the `make start` command and have this command echo out raw markdown as the\nintroduction to your chapter and instructions for completing the workshop chapter.\n\n**3. Make _run_**\nFor each branch on your workshop you need to support the `make run` command and have the command receive the path to the submission\nfile to run for the chapter. This is highly dependent on the workshop's branch excercise.\n\n**4. Make _verify_**\nFor each branch on your workshop you need to support the `make verify` command and have the command receive the path to your\nsubmission file to verify that the excercise as pertaining to the chapter has been done correctly.\n\n## Contributing\nThank you for your urge to contribute to the **workshopper** project. \nPlease find the contribution instructions in the [CONTRIBUTING](https://github.com/samuelkubai/workshopper/blob/master/CONTRIBUTING.md) file.\n\n## License\n\nMIT\n","readmeFilename":"README.md"}