generator-isocket-cortex

Yeoman generator for iSocket Cortex modules

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

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

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator 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-isocket-cortex from npm, run:

npm install -g generator-isocket-cortex

Finally, initiate the generator inside a new project directory:

yo isocket-cortex

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

Setting Up Hooks

Once you've generated your project, you'll probably want to connect travis-ci for CI and coveralls for tracking test coverage.

1. Activate GitHub Webhook on travis-ci
2. Add Repo on coveralls
3. Add coveralls repo token as environment variable in travis-ci
4. Push some code to verify your jobs ran successfully

Testing

CI

npm test

HTML Coverage

npm run test-cov-html

Fast

npm run test-fast

Test with Linting

npm run test-lint