Skip to content

drw026/workflow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Workflow

A workflow created with Gulp taskrunner.

Features:

  • SASS to CSS compiling, minifying, autoprefixing and sourcemap writing
  • Javascript concatonation and uglifying
  • Optimizing and minifying images (PNG, JPEG, GIF and SVG)
  • Cache busting
  • Live reload using BrowserSync

Getting started

For using this Gulp workflow you need to have node.js, npm and Gulp (globally) installed.

  1. Clone or download this repo into your folder.
  2. Run the following terminal command npm install in the folder where you have cloned or downloaded the repo. This will automaticly install all used dev dependencies.
  3. Create your folder structure and edit te paths in the gulp-config.json file.
  4. Create a index.html file and put <!-- inject:css --> <!-- endinject --> in the <head> tag and <!-- inject:js --> <!-- endinject --> at the bottom of the <body> tag. You may want to create for example <link rel="stylesheet" href="css/styles.css"> within the inject tags to point to the development styles or script when developing.
  5. After you have setup the paths and created some scripts and sass files you can run gulp in the terminal. This will run the default Gulp task which will start a browser with BrowserSync and watch your SASS and scripts folders.

Deployment

Run the following command to create a deployment ready app/website.

gulp deploy

This will create a new folder with concatonated and minified scripts and stylesheets. (Foldername depends how you have configured your dist path in the gulp-config.json)

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Todos

  1. Style (SASS) task
  • Autoprefixer
  1. Javascript task
  2. Browser Sync
  3. Clean dist folder for new deploys
  4. Style deploy task
  5. Javascript deploy task
  6. Images deploy task (image optimization)
  7. Cache busting assets (css & js)
  8. SASSdoc integration
  9. Bower integration
  10. HTML optimization
  11. Merge Media Queries

Licence

The MIT License (MIT) Copyright (c) 2016 Andrew Reasoa

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.

Releases

No releases published

Packages

No packages published