generator-vars-webapp v2.1.0

generator-vars-webapp

Yeoman generator for a raw front-end web app.

Features

• Bower
• Gulp setup for CSS, JavaScript, and HTML minification as well as static asset revisioning (appending content hash to filenames)
• BrowserSync for rapid development
• Sass/Stylus with Scalable and Modular Architecture (SMACSS) setup
• templating using gulp-file-include
• Browserify with Babelify and Watchify

Libraries

• Bootstrap (optional)
• Modernizr (optional)
• jQuery

Structure

.
+-- .bowerrc
+-- .editorconfig
+-- .gitattributes
+-- .gitignore
+-- .jshintrc
+-- app
|   +-- .htaccess
|   +-- .jshintrc
|   +-- fonts
|   +-- images
|   |   +-- apple-touch-icon-57x57.png
|   |   +-- apple-touch-icon-72x72.png
|   |   +-- apple-touch-icon-114x114.png
|   |   +-- apple-touch-icon.png
|   |   +-- favico.png
|   |   +-- og-image.png
|   +-- scripts
|   |   +-- main.js
|   +-- styles
|   |   +-- base
|   |   |   +-- definitions.{scss,styl}
|   |   |   +-- layout.{css,scss,styl}
|   |   |   +-- normalize.{css,scss,styl}
|   |   |   +-- typography.{css,scss,styl}
|   |   +-- components
|   |   +-- modules
|   |   +-- main.{scss,styl}
|   +-- videos
|   +-- 404.html
|   +-- favico.ico
|   +-- index.html
|   +-- README.md
|   +-- robots.txt
+-- public // runtime files go here
+-- bower_components
+-- node_modules
+-- tasks
|   +-- .jshintrc
|   +-- .taskconfig
|   +-- build.js
|   +-- clean.js
|   +-- serve.js
|   +-- wiredep.js
+-- test
|   +-- bower_components
|   +-- spec
|   +-- index.html
|   +-- bower.json
+-- gulpfile.js
+-- bower.json
+-- package.json

Tasks

gulp --debug --watch --serve: Compiles all assets/templates, serves the site and watches for file changes. Best used during development.

gulp: Builds the entire project in production.

All tasks are broken into micro-tasks, check out the tasks folder for more details. Also see tasks/.taskconfig for more custom flags such as --skip-js-min, --skip-css-min, etc.

Usage

Install yo:

npm install -g yo

Install generator-vars-webapp:

npm install -g generator-vars-webapp

Create a new directory for your project and cd into it:

mkdir new-project-name && cd $_

Generate the project:

yo vars-webapp [app-name]

For details on initial setup procedures of the project, see its generated README.md file.

Release Notes

2.1.0

This generator uses a dated approach to generate static websites, hence it's no longer maintained. The web advances quickly :)

2.0.0

1. Updated version numbers of NPM package dependencies.
2. Gulp tasks are now compressed into fewer files. As a result require-dir dependency is no longer necessary and is removed from package.json.
3. Task configurations are now stored in ./tasks/.taskconfig.
4. favicon.png, Apple touch and Open Graph specific icons are now moved to app/images. favicon.ico remains in the root directory.
5. gulp-imagemin is removed because it is the most taxing task in the Gulp pipeline. Images should be optimized outside of the Gulp pipeline instead.
6. Runtime files are now deployed to ./public instead of ./build.
7. Minor syntactic sugar changes.
8. Lots of optimizations, particularly boosting the efficiency of automated rebuilds during development.

License

This software is released under the MIT License.