generator-node-api

Yeoman generator

Work in progress

Havent started on documentation yet

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

npm install -g generator-node-api

Finally, initiate the generator:

yo node-api

Things you can do with node-api

App skeleton

yo node-api

Creates a basic node app

root/
├── config
|   ├──db.js
|   ├──application.js
├── app.js
├── node_modules/
├── .editorconfig
├── .jshintrc
├── .yo-rc.json
├── Gulpfile.js
├── package.json
├── README.md

Scaffolding Controllers, Routes, and Models

yo node-api:scaffold NAME

yo node-api:scaffold NAME --skip-model

yo node-api:scaffold NAME --only-controller

###Run yo node-api before you run the scaffold. Will scaffold an application for you just like rails and add the files to your project ;-]

root/
├── controllers
|   ├──nameController.js
├── models
|   ├──nameModel.js
├── routers
|   ├──nameroutes.js

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.

License

MIT