Yeoman generator for browserify-based frontend projects
An opinionated Yeoman generator that scaffolds a Browserify-based, Grunt-built web app.
- Browserify with JS source maps
- LESS Hat mixin library
- Grunt file watcher
- Grunt HTML builder
- LESS compiler with clean-css minifier
- Connect server
- UglifyJS minifier
First install Yeoman if you haven't already:
npm install -g yo
Install from NPM:
npm install -g generator-make-it-happen
(or, if you'd like to make changes to the generator, clone
the repository and run
npm link instead)
Then create a directory for your project and run the generator:
mkdir my-project && cd $_yo make-it-happen
You will be guided by the friendly Yeoman through creating your new app's scaffold and installing dependencies. All app
code will live in the newly-created
src directory and builds will be located in
build. NOTE: files in the
directory should never be modified, as they will be overwritten whenever the grunt task is run. Write all app code in
Now you can run the development server:
grunt debug// or grunt serve
This will create a development build in
build/dev, serve index.html from http://localhost:4000 (or whichever port you
specified), and watch for changes to the code, automatically rebuilding as necessary. Go to localhost:4000 to see
examples of all the installed features. It may be helpful to save this examples page for future reference before
replacing it with your app code.
To build a minified version of the app for distribution, run the 'build' grunt task:
The production build will be created in
Planned features in rough order of priority:
- Unit tests for generator
- Unit testing framework(s) for app
- LESS source maps
- Image (PNG/GIF/JPG/SVG) minification
- Sprite generation
- Choice of Underscore or Lodash
- Cleanup method
- Backbone option?
See the contributing docs.
Bugs and feature requests may be reported on the Github issues page.
Pull requests are welcome. However, this is an opinionated generator, and your opinions on what should be included may differ from ours. For this reason, filing an issue to discuss your planned contribution before writing any code is encouraged.
Copyright © 2014 email@example.com
This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING.md file for more details.