https://github.com/workshopper/workshopper-adventure

Not an adventure, not a workshopper - its both!
https://github.com/workshopper/workshopper-adventure

nodeschool workshopper

Last synced: 2 days ago
JSON representation

Not an adventure, not a workshopper - its both!

• Host: GitHub
• URL: https://github.com/workshopper/workshopper-adventure
• Owner: workshopper
• License: other
• Created: 2015-05-19T00:01:57.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-02-03T02:51:30.000Z (about 1 year ago)
• Last Synced: 2024-04-14T05:35:00.780Z (10 months ago)
• Topics: nodeschool, workshopper
• Language: JavaScript
• Size: 1.39 MB
• Stars: 241
• Watchers: 19
• Forks: 43
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Workshopper-Adventure

**A flexible terminal workshop runner framework**

[![Join the chat at https://gitter.im/nodeschool/workshoppers](https://badges.gitter.im/nodeschool/workshoppers.svg)](https://gitter.im/nodeschool/workshoppers) [![Build Status](https://api.travis-ci.org/workshopper/workshopper-adventure.svg?branch=master)](https://travis-ci.org/workshopper/workshopper-adventure) [![Dependency Status](https://david-dm.org/workshopper/workshopper-adventure.svg)](https://david-dm.org/workshopper/workshopper-adventure)

[![NPM](https://nodei.co/npm/workshopper-adventure.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/workshopper-adventure/) [![NPM](https://nodei.co/npm-dl/workshopper-adventure.png?months=3&height=3)](https://nodei.co/npm/workshopper-adventure/)

![Learn You The Node.js For Much Win!](https://raw.github.com/rvagg/learnyounode/master/learnyounode.png)

**Workshopper** was used by **[learnyounode](https://github.com/rvagg/learnyounode)**, and other Node.js command-line workshop applications.

**Adventure** was used by **[javascripting](https://github.com/sethvincent/javascripting)**, and other Node.js command-line workshop applications.

**Workshopper-Adventure** allows you to create a workshop written

like either of those frameworks!

[@linclark](https://github.com/linclark) has written a good introduction on creating your own workshop, available [here](https://github.com/linclark/lin-clark.com/blob/master/content/blog/2014/07/01/authoring-nodejs-workshopper-lessons.md).

## High-level overview

Workshopper-Adventure is essentially a *test-runner* with a fancy terminal UI. The Workshopper package itself is largely concerned with the menu system and some of the basic command-line parsing. Much of the work for executing the exercise validation is handled by [workshopper-exercise](http://github.com/rvagg/workshopper-exercise).

### Contributors

workshopper is proudly brought to you by the following hackers:

* [@rvagg](https://github.com/rvagg)

* [@substack](https://github.com/substack)

* [@maxogden](https://github.com/maxogden)

* [@cjb](https://github.com/cjb)

* [@wpreul](https://github.com/wpreul)

* [@davglass](https://github.com/davglass)

* [@Rowno](https://github.com/Rowno)

* [@wilmoore](https://github.com/wilmoore)

* [@evilpacket](https://github.com/evilpacket)

* [@bobholt](https://github.com/bobholt)

* [@jessmartin](https://github.com/jessmartin)

* [@braz](https://github.com/braz)

* [@timoxley](https://github.com/timoxley)

* [@dominictarr](https://github.com/dominictarr)

* [@dominhhai](https://github.com/dominhhai)

* [@minatu2d](https://github.com/minatu2d)

* [@wewark](https://github.com/wewark)

#### Maintainers

* [@martinheidegger](https://github.com/martinheidegger)

## License

**Workshopper-Adventure** is Copyright (c) 2015 Martin Heidegger [@martinheidegger](https://github.com/martinheidegger) and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.

it is originally a fork of **Workshopper**

**Workshopper** is Copyright (c) 2013-2015 Rod Vagg [@rvagg](https://twitter.com/rvagg) and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.

**Workshopper-Adventure** builds on the excellent work by [@substack](https://github.com/substack) and [@maxogden](https://github.com/maxogden) who created **[stream-adventure](https://github.com/substack/stream-adventure)** which serves as the original foundation for **Workshopper** and **learnyounode**. Portions of **Workshopper** may also be Copyright (c) 2013 [@substack](https://github.com/substack) and [@maxogden](https://github.com/maxogden) given that it builds on their original code.