generator-webgen

Yeoman generator

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

What is webgen?

####Features

• CSS Autoprefixing

• Built-in preview server with livereload

• Automagically compile Sass

• Automagically lint your scripts

• Awesome image optimization

• Automagically wire-up dependencies installed with Bower (when gulp watch or gulp wiredep)

####Getting Started

Install: npm install -g generator-webgen

Run: yo webgen
Submodule: yo webgen:comp

Run gulp for building to the dist directory and gulp serve for preview.

Output

  ├── app
  |    ├── en
  |         ├── components
  |               ├── breadcrumb
  |                     ├── _breadcrumb.scss
  |                     └── breadcrumb.jade
  |               ├── spotlight
  |                     ├── _spotlight.scss
  |                     ├── spotlight.jade
  |                     └── spotlight.js
  |         ├── favicon.ico
  |         ├── humans.txt
  |         ├── images
  |               ├── icons
  |                     └── icon-search.png
  |               ├── logo.png
  |               ├── tmp
  |               └── touch
  |         ├── manifest.webapp
  |         ├── pagelayout
  |               └── col3_l.jade
  |         ├── pages
  |               ├── 001_homepage_v1_6.jade
  |               ├── shared
  |                     ├── _footer.jade
  |                     ├── _header.jade
  |                     ├── _master.jade
  |                     ├── _mixin.jade
  |                     ├── _scriptLinks.jade
  |                     └── _styleLinks.jade
  |         ├── robots.txt
  |         ├── scripts
  |               ├──  common.js
  |               ├──  main.js
  |               └──  vendor
  |         └── styles
  |               ├── fonts
  |               ├── scss
  |                     ├──  _config.scss
  |                     ├──  _legos.scss
  |                     ├──  main.scss
  |                     └──  responsive.scss
  |               └── vendor
  │
  ├── .editorconfig
  ├── .gitattributes
  ├── .gitignore
  ├── .jshintrc
  ├── LICENSE
  ├── package.json
  ├── gulp.js
  └── README.md

####Options

--skip-install Skips the automatic execution of bower and npm after scaffolding has finished.

submodules

Create components

  yo webgen:comp name [options]

  yo webgen:comp spotlight -l=ar -n="spotlightHomepage"

-l Language identifier.

-n Add new file to exsisting component.

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

npm install -g generator-webgen

Finally, initiate the generator:

yo webgen

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