Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yeoman/generator-webapp_DEPRECATED
Yeoman generator that scaffolds out a front-end web app
https://github.com/yeoman/generator-webapp_DEPRECATED
Last synced: about 2 months ago
JSON representation
Yeoman generator that scaffolds out a front-end web app
- Host: GitHub
- URL: https://github.com/yeoman/generator-webapp_DEPRECATED
- Owner: yeoman
- Archived: true
- Created: 2012-11-21T23:20:28.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2017-02-11T23:54:16.000Z (over 7 years ago)
- Last Synced: 2024-07-21T03:37:02.158Z (2 months ago)
- Language: JavaScript
- Homepage: http://yeoman.io
- Size: 725 KB
- Stars: 975
- Watchers: 63
- Forks: 310
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
Awesome Lists containing this project
README
# Web app generator [](http://travis-ci.org/yeoman/generator-webapp) [](https://gitter.im/yeoman/yeoman)
[Yeoman](http://yeoman.io) generator that scaffolds out a front-end web app.
## Looking for New Maintainers
This generator is not actively maintained because we're focusing on [generator-gulp-webapp](https://github.com/yeoman/generator-gulp-webapp), which is very similar, but uses [gulp](http://gulpjs.com) instead of Grunt.
We would be happy to take on new maintainers and will still be around for merging PRs.
## Features
* CSS Autoprefixing
* Built-in preview server with LiveReload
* Automagically compile ES6 (with Babel) & Sass
* Automagically lint your scripts
* Automagically wire up your Bower components with [grunt-wiredep](#third-party-dependencies).
* Awesome Image Optimization (via OptiPNG, pngquant, jpegtran and gifsicle)
* Mocha Unit Testing with PhantomJS
* Bootstrap for Sass (Optional)
* Leaner Modernizr builds (Optional)
For more information on what `generator-webapp` can do for you, take a look at the [Grunt tasks](https://github.com/yeoman/generator-webapp/blob/master/app/templates/_package.json) 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[\*](#grunt-serve-note). `--allow-remote` option for remote access.
#### Third-Party Dependencies
*(HTML/CSS/JS/Images/etc)*
Third-party dependencies are managed with [grunt-wiredep](https://github.com/stephenplusplus/grunt-wiredep). Add new dependencies using **Bower** and then run the **Grunt** task to load them:
```sh
$ bower install --save jquery
$ grunt wiredep
```
This works if the package author has followed the [Bower spec](https://github.com/bower/bower.json-spec). If the files are not automatically added to your source code, 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 --save depName` to get the files, then add a `script` or `style` tag to your `index.html` or another appropriate place.
The components are installed in the root of the project at `/bower_components`. To reference them from index.html, use `src="bower_components"` or `src="/bower_components"`. Treat the `bower_components` directory as if it was a sibling to `index.html`.
*Testing Note*: a project checked into source control and later checked out needs to have `bower install` run from the `test` folder as well as from the project root.
#### Grunt Serve Note
Note: `grunt server` was used for previewing in earlier versions of the project, and has since been deprecated in favor of `grunt serve`.
## Docs
We have [recipes](docs/recipes) for integrating other popular technologies like Compass.
## Options
* `--skip-install`
Skips the automatic execution of `bower` and `npm` after scaffolding has finished.
* `--test-framework=`
Either `mocha` or `jasmine`. Defaults to `mocha`.
* `--no-babel`
Turn off [Babel](http://babeljs.io/) support.
## Contribute
See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contributing.md).
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.
## 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)