Yeoman generator that scaffolds out a front-end web app using gulp for the build process
Features
Please see our gulpfile for up to date information on what we support.
- enable ES2015 features using Babel
- CSS Autoprefixing
- Built-in preview server with BrowserSync
- Automagically compile Sass with libsass
- Automagically lint your scripts
- Map compiled CSS to source stylesheets with source maps
- Awesome image optimization
- Automagically wire-up dependencies installed with Bower
For more information on what this generator can do for you, take a look at the gulp plugins used in our package.json
.
libsass
Keep in mind that libsass is feature-wise not fully compatible with Ruby Sass. Check out this 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 and update the styles
task in gulpfile accordingly.
Getting Started
- Install dependencies:
npm install --global yo gulp-cli bower
- Install the generator:
npm install --global generator-webapp
- Run
yo webapp
to scaffold your webapp - Run
gulp serve
to preview and watch for changes - Run
bower install --save <package>
to install frontend dependencies - Run
gulp serve:test
to run the tests in the browser - Run
gulp
to build your webapp for production - Run
gulp serve:dist
to preview the production build
Docs
- getting started with this generator
- recipes for integrating other popular technologies like CoffeeScript
- details about our Bower setup
- contribution docs and FAQ, 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
Skips the automatic execution ofbower
andnpm
after scaffolding has finished.--test-framework=<framework>
Eithermocha
orjasmine
. Defaults tomocha
.--no-babel
Scaffolds without Babel support. This only applies toapp/scripts
, you can still write ES2015 in the gulpfile, depending on what your version of Node supports.
Contribute
See the contributing docs.
Sponsors
Love Yeoman work and community? Help us keep it alive by donating funds to cover project expenses!
[Become a sponsor]