Kettle is a boilerplate gulpfile.js for use in front-end projects.
- Sass
- Compiling
- Autoprefixer
- Sourcemaps (if
--dev
) - Minification (if
--production
) - Combine Media Queries (if
--production
)
- JS
- Compiling
- Sourcemaps (if
--dev
) - JSHint Error Reporting
- Uglify (if
--production
)
- Images
- Compiling
- Lossless Optimisation (if
--production
)
- Fonts
- Compiling
- Bower
- Install components from the bower.json file
- Browser Sync (if
--dev
)- CSS Injecting
- JS Auto reload page
+-- assets/
| +-- fonts
| +-- images
| +-- scripts
| +-- styles
+-- build/
| +-- styles
| +-- scripts
| +-- images
| +-- fonts
+-- bower_components/
+-- gulp-tasks/
| +-- browser-sync.js
| +-- build.js
| +-- clean.js
| +-- default.js
| +-- fonts.js
| +-- images.js
| +-- js.js
| +-- scss.js
+-- node_modules/
+-- package.json/
+-- gulpfile.js/
- Run
$ npm install
to install packages.
- Run
$ npm run default
and start developing
$ npm run default
- Default task, builds assets, starts watching directories for changes.$ npm run default-dev
- Default task, builds assets, starts watching directories for changes with dev tools enabled (Sourcemaps, browserSync etc).$ npm run build
- Rebuilds all assets (inc bower_components)$ npm run build-production
- Rebuilds all assets in production format (Minification etc).
- gulp
- gulp-sass
- gulp-autoprefixer
- gulp-jshint
- gulp-imagemin
- gulp-cssnano
- gulp-combine-mq
- gulp-uglify
- gulp-clip-empty-files
- gulp-util
- gulp-changed
- gulp-sourcemaps
- Error Handling (Plumber)
- Notifications (Error Details / Success) (Disabled by default)
- Move from Bower to NPM for Front-End Packages
- POST CSS branch
- NPM only branch (no Gulp)
The MIT License (MIT)
Copyright (c) 2015 Jake Cobley
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.