Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100755 76 lines (50 sloc) 2.784 kB
75d91bb @Marak [doc] updating ReadMe
Marak authored
1
4395647 @Marak [doc] updating ReadMe, removed bad eyes require
Marak authored
2
25bb847 @Marak [doc] updated logo
Marak authored
3 <img src="http://imgur.com/RcVnG.png" border="0"/>
4e835fd @Marak added image
Marak authored
4
5545988 @Marak [doc] updating ReadMe
Marak authored
5 # a collaborative bdd project planning tool for node
6
7
8 prenup allows you to meaningfully engage your clients and convert their domain knowledge into tangible milestones, features, scenarios, and unit tests.
75d91bb @Marak [doc] updating ReadMe
Marak authored
9
f8cace5 @FotoVerite more readme work
FotoVerite authored
10
9e48b90 @Marak [doc] cleaning up the docs! ♪ ♫
Marak authored
11 ## features
f8cace5 @FotoVerite more readme work
FotoVerite authored
12
9e48b90 @Marak [doc] cleaning up the docs! ♪ ♫
Marak authored
13 - Scenarios are created using [kyuri][1], a custom dialect of [Gherkin][12] geared towards asynchronous programming
1eb7e04 @Marak updating readme
Marak authored
14 - Intuitive and friendly user interface that takes the frustration out of Behavior Driven Development
332b84d @Marak updating readme
Marak authored
15 - Generates [VowsJS][3] testing stubs (Vows is a well established node.js testing framework)
1eb7e04 @Marak updating readme
Marak authored
16 - Milestones, Features, Scenarios, Points
17 - Support for 160+ languages
396e316 @Marak rename projects like woah
Marak authored
18 - Heavily influenced by Cucumber. If you know [Cuke][10], you know prenup.
5f1bd2e @Marak updating readme
Marak authored
19
20
21 ## things that would be implemented if we didn't build this in 48 hours
62adc50 @FotoVerite basic readme
FotoVerite authored
22
5f1bd2e @Marak updating readme
Marak authored
23 - real-time project management collaboration using [socket.io][9]
24 - user accounts using [roles.js][7]
25 - automated billing using [paynode][8]
26 - native mobile app (iPhone / iPad / BlackBerry) using [Titanium AppCelerator][6]
62adc50 @FotoVerite basic readme
FotoVerite authored
27
4395647 @Marak [doc] updating ReadMe, removed bad eyes require
Marak authored
28 ##Usage
1eb7e04 @Marak updating readme
Marak authored
29
4395647 @Marak [doc] updating ReadMe, removed bad eyes require
Marak authored
30 ### using prenup locally
1eb7e04 @Marak updating readme
Marak authored
31 <pre>
4395647 @Marak [doc] updating ReadMe, removed bad eyes require
Marak authored
32 git clone git@github.com:nodejitsu/prenup.git
33 cd prenup
34 node server.js
1eb7e04 @Marak updating readme
Marak authored
35 </pre>
36
4395647 @Marak [doc] updating ReadMe, removed bad eyes require
Marak authored
37 ### using prenup online
1eb7e04 @Marak updating readme
Marak authored
38
4b97b33 @Marak [doc] updated broken link in ReadMe
Marak authored
39 visit [http://prenup.nodejitsu.com][5]
1eb7e04 @Marak updating readme
Marak authored
40
9e48b90 @Marak [doc] cleaning up the docs! ♪ ♫
Marak authored
41 ## Vows
1eb7e04 @Marak updating readme
Marak authored
42
4395647 @Marak [doc] updating ReadMe, removed bad eyes require
Marak authored
43 [VowsJS][3] is a popular [Behavior Driven Development][4] framework for node.js. Vows was built from the ground up to test asynchronous code. It executes your tests in parallel when it makes sense, and sequentially when there are dependencies.
1eb7e04 @Marak updating readme
Marak authored
44
f51e591 @Marak [doc] updating ReadMe
Marak authored
45 Instead of crafting your VowsJS code from hand (using JavaScript), kyuri allows you to auto-generate Vows stubs.
1eb7e04 @Marak updating readme
Marak authored
46
9e48b90 @Marak [doc] cleaning up the docs! ♪ ♫
Marak authored
47 ## kyuri
1eb7e04 @Marak updating readme
Marak authored
48
9e48b90 @Marak [doc] cleaning up the docs! ♪ ♫
Marak authored
49 [kyuri][1] comes pre-bundled with prenup. [kyuri][1] is the language used to describe your Features and Scenarios. [kyuri][1] is a dialect of Gherkin, a well establish BDD language made popular by [Cucumber][10].
1eb7e04 @Marak updating readme
Marak authored
50
62adc50 @FotoVerite basic readme
FotoVerite authored
51
9e48b90 @Marak [doc] cleaning up the docs! ♪ ♫
Marak authored
52 ## authors
53 ### created for node knockout 2010 by The NYC Nodejitsu Ninjas
7ad6f5a links added to readme
hij1nx authored
54 #### [indexzero][15], [hij1nx][14], [FotoVerite][16] & [Marak][13]
62adc50 @FotoVerite basic readme
FotoVerite authored
55
9e48b90 @Marak [doc] cleaning up the docs! ♪ ♫
Marak authored
56 ### acknowledgments
485d3ff @FotoVerite added lookup table
FotoVerite authored
57 Heavily inspired by Sean Cribbs' [Lowdownapp][4], an entry in the 2009 Rails Rumble
b9c8a8d @Marak updating docs
Marak authored
58
59
9e48b90 @Marak [doc] cleaning up the docs! ♪ ♫
Marak authored
60 [1]: http://github.com/nodejitsu/kyuri "kyuri"
485d3ff @FotoVerite added lookup table
FotoVerite authored
61 [2]: http://cukes.info/ "Cucumber"
62 [3]: http://vowsjs.org/ "Vowjs"
63 [4]: http://lowdownapp.com/ "Lowdownapp"
9e48b90 @Marak [doc] cleaning up the docs! ♪ ♫
Marak authored
64 [5]: http://prenup.nodejitsu.com/ "prenup"
5f1bd2e @Marak updating readme
Marak authored
65 [6]: http://www.appcelerator.com/ "Titanium AppCelerator"
66 [7]: http://github.com/marak/roles.js/ "roles.js"
67 [8]: http://github.com/jamescarr/paynode "paynode"
68 [9]: http://socket.io/ "socket.io"
19308bd @Marak updating readme
Marak authored
69 [10]: http://cukes.info "Cucumber"
332b84d @Marak updating readme
Marak authored
70 [11]: http://nodejs.org "node.js"
e67c79e @Marak updating readme
Marak authored
71 [12]: http://wiki.github.com/aslakhellesoy/cucumber/gherkin "gherkin"
7ad6f5a links added to readme
hij1nx authored
72 [13]: http://github.com/Marak "Marak"
73 [14]: http://github.com/hij1nx "hij1nx"
74 [15]: http://github.com/indexzero "indexzero"
75 [16]: http://github.com/FotoVerite "FotoVerite"
Something went wrong with that request. Please try again.