generator-iris

Scaffold out a front-end Iris web app

npm install generator-iris
36 downloads in the last month

generator-iris Build Status

A generator for Yeoman.

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

$ npm install -g generator-iris

Initiate the generator (create the directory project previously):

$ yo iris

To start de server:

$ grunt

And navigate to http://localhost:8080

Finally, for create new components the are two ways.

First way (passing the components names):

$ yo iris:new [[parent/]component-name]...

Example:

$ yo iris:new main/home main/exit

Two components will be added to the init.js file and to the filesystem (their types will be asked).

Second way (reading de init.js file):

$ yo iris:new-from-init

This will read iris.path variable from the init.js file searching for those files that do not exist and It will create them.

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 License

npm loves you