fabiofabbrucci / generator-webapp

Yeoman generator that scaffolds out a front-end web app

Web app generator

Yeoman generator that scaffolds out a front-end web app.

Features

• CSS Autoprefixing (new)
• Built-in preview server with LiveReload
• Automagically compile CoffeeScript & Compass
• Automagically lint your scripts
• Automagically wire up your Bower components with bower-install.
• Awesome Image Optimization (via OptiPNG, pngquant, jpegtran and gifsicle)
• Mocha Unit Testing with PhantomJS
• Optional - Twitter Bootstrap for SASS
• Optional - Leaner Modernizr builds (new)

For more information on what generator-webapp can do for you, take a look at the Grunt tasks used in our package.json.

Getting Started

• Install: npm install -g generator-webapp
• Run: yo webapp
• Run grunt for building and grunt serve for preview *

Third-Party Dependencies

(HTML/CSS/JS/Images/etc)

Third-party dependencies are managed with bower-install. Add new dependencies using Bower and then run the Grunt task to load them:

  bower install --save jquery
  grunt bower-install

This works if the package author has followed the Bower spec. If the files are not automatically added to your index.html, check with the package's repo for support and/or file an issue with them to have it updated.

To manually add dependencies, bower install depName --save to get the files, then add a script or style tag to your index.html or an other appropriate place.

Grunt Serve Note

Note: grunt server was previously used for previewing in earlier versions of the project and is being deprecated in favor of grunt serve.

Options

• --skip-install

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

• --test-framework=<framework>

  Defaults to mocha. Can be switched for another supported testing framework like jasmine.

• --coffee

  Add support for CoffeeScript.

Contribute

See the contributing docs

Note: We are regularly asked whether we can add or take away features. If a change is good enough to have a positive impact on all users, we are happy to consider it.

If not, generator-webapp is fork-friendly and you can always maintain a custom version which you npm install && npm link to continue using via yo webapp or a name of your choosing.

License

BSD license