View on GitHub


An egress generator for Yeoman

Download this project as a .zip file Download this project as a tar.gz file

generator-egress Build Status

An egress site generator for Yeoman.

A generator for Yeoman, based on egress-bootstrap, a minimal Express app template for a user account system. I built this with the intention of getting user-based node.js apps scaffolded out quickly.

egress-bootstrap Dependencies

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

$ npm install -g generator-egress

Finally, initiate the generator:

$ yo egress

After you generate your egress website, look at the generated for steps to get started.

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.



You can most easily reach me on twitter @_Shakeel


MIT License