Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yeoman/generator-webapp

A gulp.js generator for modern webapps
https://github.com/yeoman/generator-webapp

gulp yeoman

Last synced: 1 day ago
JSON representation

A gulp.js generator for modern webapps

Awesome Lists containing this project

README

        

# Web app generator [![Build Status](https://secure.travis-ci.org/yeoman/generator-webapp.svg?branch=master)](http://travis-ci.org/yeoman/generator-webapp) [![Gitter](https://img.shields.io/badge/Gitter-Join_the_Yeoman_chat_%E2%86%92-00d06f.svg)](https://gitter.im/yeoman/yeoman)

> [Yeoman](http://yeoman.io) generator that scaffolds out a front-end web app using [gulp](http://gulpjs.com/) for the build process

![](screenshot.png)

---

🚧 There is a pre-release version of this generator, you can install it by running `npm install --global generator-webapp@next`. Help us make it stable by reporting bugs! 🚧

---

## Features

Please see our [gulpfile](app/templates/gulpfile.js) for up to date information on what we support.

* enable [ES2015 features](https://babeljs.io/docs/learn-es2015/) using [Babel](https://babeljs.io)
* CSS Autoprefixing
* Built-in preview server with BrowserSync
* Automagically compile Sass with [libsass](http://libsass.org)
* Automagically lint your scripts
* Map compiled CSS to source stylesheets with source maps
* Awesome image optimization

*For more information on what this generator can do for you, take a look at the [gulp plugins](app/templates/_package.json) used in our `package.json`.*

## libsass

Keep in mind that libsass is feature-wise not fully compatible with Ruby Sass. Check out [this](http://sass-compatibility.github.io) curated list of incompatibilities to find out which features are missing.

If your favorite feature is missing and you really need Ruby Sass, you can always switch to [gulp-ruby-sass](https://github.com/sindresorhus/gulp-ruby-sass) and update the `styles` task in gulpfile accordingly.

## Getting Started

- Install: `npm install --global yo gulp-cli generator-webapp`
- Run `yo webapp` to scaffold your webapp
- Run `npm start` to preview and watch for changes
- Run `npm start -- --port=8080` to preview and watch for changes in port `8080`
- Run `npm install --save ` to install dependencies, frontend included
- Run `npm run serve:test` to run the tests in the browser
- Run `npm run serve:test -- --port=8085` to run the tests in the browser in port `8085`
- Run `npm run build` to build your webapp for production
- Run `npm run serve:dist` to preview the production build
- Run `npm run serve:dist -- --port=5000` to preview the production build in port `5000`

## Docs

* [getting started](docs/README.md) with this generator
* [recipes](docs/recipes/README.md) for integrating other popular technologies like CoffeeScript
* [contribution](contributing.md) docs and [FAQ](docs/faq.md), good to check before posting an issue

## Options

- `--skip-welcome-message`
Skips Yeoman's greeting before displaying options.
- `--skip-install-message`
Skips the the message displayed after scaffolding has finished and before the dependencies are being installed.
- `--skip-install`
Doesn't automatically install dependencies after scaffolding has finished.
- `--test-framework=`
Either `mocha` or `jasmine`. Defaults to `mocha`.

## Contribute

See the [contributing docs](contributing.md).

## Sponsors
Love Yeoman work and community? Help us keep it alive by donating funds to cover project expenses!

[[Become a sponsor](https://opencollective.com/yeoman#support)]


























































































## License

[BSD license](http://opensource.org/licenses/bsd-license.php)