daVinci

Experimental project structure focusing on simplicity by utilizing node.js and feature driven development.

Documentation generated by Markdox via gulp-markdox

Requirements

• Slush

npm install slush -g

Getting Started

npm install slush-davinci -g
slush davinci

default()

The default generator. It generates everything in generators/base.

Example

slush davinci

# Requested User Input
# appName: Name of application to be used in package.json and other generated files.
# appDescription: Description of application to be used in package.json and other generated files.
# appVersion: Semantic Version number of generated application.
# authorName:
# authorEmail:
# userName: GitHub username.
# moveon: Confirms generator configuration values and starts generation if `true`.

Outputs

/appName
|--.gitignore
|--index.html
|--README.md

Developing This Generator

It is not necessary to have gulp installed globally. Use

npm run task -- [taskname] #space is necessary between -- and [taskname]

Otherwise use gulp as normal.

gulp [taskname]

docs()

Generate documentation. This task searches all js files for inline documentation and generates markdown. It then concatenates the markdown to the end of PREFACE.md and finally writes that to README.md.

Example

npm run task -- docs
# or if you have gulp installed globally
gulp docs

See: Markdox#Quickstart

test()

Starts tests. Mocha is the testing framework used with Chai assertion library.

Example

npm test
# which is just an alias for
npm run task -- test
# or if you have gulp installed globally
gulp test