Generator-node-boilerplate NPM

generator-node-boilerplate

A generator for Yeoman. This generator creates a boilerplate for a Node.js thin server, meant for creating a RESTful API, and an Ember.js client side, single page application that consumes the API.

The boilerplate also generates a sample todo application. The todo application is the "hello, world" of client side MVC frameworks. This particular todo application is a copy of the code, adapted to use the REST adapter, found in the Ember.js guides. I do not claim to have written it myself.

Requirements to use this generator are:

Global installation of Yeoman (of course),
Global installation of CoffeeScript,
Installation of ruby SASS,
MongoDB.

All are welcome to help make this generator great.

Getting Started

What is Yeoman?

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

npm.io

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-node-boilerplate from npm, run:

$ npm install -g generator-node-boilerplate

Finally, initiate the generator:

$ yo node-boilerplate

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.