generator-ms-npm

Yeoman generator

Getting Started

What is Yeoman?

Basically, he lives in your computer, and waits for you to tell him what kind of application you wish to create.

Install yeoman:

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't doesn't come with any generators. A generator is like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-ms-npm from npm, run:

npm install -g generator-ms-npm

Finally, initiate the generator:

yo ms-npm <appname>

Full NPM workflow

Assuming we wish to create a module called my-module

• Create a github repo called my-module under the mediasuitenz organisation, on the travis ci site, add the repo
• Run the following:

yo ms-npm my-module

• Answer the questions (mostly accept the defaults where applicable)
• Run the following:

cd my-module
git add .
git commit -m "Initial commit"
git push origin master #the git remote has already been added by yeoman

• fire up testem

npm run test:dev 

• Add your module code to index.js and your tests to the /test folder (as .spec.js files)
• Commit your changes
• Version your code (starts at 0.0.0)

npm version patch -m "added some code"

• push your code

git push origin master
git push origin --tags

• Publish your module

npm publish

License

MIT