Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/workshopper/workshopper

A terminal workshop runner framework
https://github.com/workshopper/workshopper

Last synced: about 15 hours ago
JSON representation

A terminal workshop runner framework

Host: GitHub
URL: https://github.com/workshopper/workshopper
Owner: workshopper
License: other
Created: 2013-08-11T10:18:32.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2024-07-17T17:31:58.000Z (7 months ago)
Last Synced: 2025-02-07T12:08:33.443Z (8 days ago)
Language: JavaScript
Homepage:
Size: 862 KB
Stars: 1,106
Watchers: 34
Forks: 138
Open Issues: 30
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-workshopper - rvagg/workshopper
awesome-github-repos - workshopper/workshopper - A terminal workshop runner framework (JavaScript)

README

        # Workshopper

[![Join the chat at https://gitter.im/nodeschool/workshoppers](https://badges.gitter.im/nodeschool/workshoppers.svg)](https://gitter.im/nodeschool/workshoppers?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

# Workshopper is no longer maintained

In mid-term workshopper will be replaced with [`workshopper-adventure`](https://github.com/workshopper/workshopper-adventure). Please try to build new workshoppers against workshopper-adventure. Thanks. (your maintainer)

# Readme until now:

**A terminal workshop runner framework**

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

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

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

*Documentation is being written for the v1 rewrite right now! Ping @rvagg if you need anything. **learnyounode** is now using this new version, for now you can use it to see how this works.

For now, [@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 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)

#### Maintainers

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

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

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

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

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

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

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

## License

**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** 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.