Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AdFabConnect/adfab-gulp-boilerplate
A boilerplate including Gulp, Less/SASS, BrowserSync.
https://github.com/AdFabConnect/adfab-gulp-boilerplate
boilerplate browsersync css gulp less
Last synced: 3 months ago
JSON representation
A boilerplate including Gulp, Less/SASS, BrowserSync.
- Host: GitHub
- URL: https://github.com/AdFabConnect/adfab-gulp-boilerplate
- Owner: AdFabConnect
- License: isc
- Created: 2016-04-25T15:54:45.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-12-03T15:55:04.000Z (about 4 years ago)
- Last Synced: 2024-04-24T01:02:19.310Z (9 months ago)
- Topics: boilerplate, browsersync, css, gulp, less
- Language: JavaScript
- Homepage: https://adfabconnect.github.io/adfab-gulp-boilerplate/
- Size: 4.96 MB
- Stars: 16
- Watchers: 35
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ADFAB Gulp Boilerplate
> The goal of this [Gulp](http://gulpjs.com/) boilerplate is to free you time so you can do something more interesting than reinventing the wheel.
[](http://badge.fury.io/js/adfab-gulp-boilerplate)
[](https://travis-ci.org/AdFabConnect/adfab-gulp-boilerplate)
[](https://david-dm.org/AdFabConnect/adfab-gulp-boilerplate)
[](https://david-dm.org/AdFabConnect/adfab-gulp-boilerplate#info=devDependencies)
[](https://raw.githubusercontent.com/AdFabConnect/adfab-gulp-boilerplate/master/LICENSE)
## Features
* Automatic reloading of the browser on code modification (using [Browsersync](https://www.browsersync.io/))
* CSS / JS Sourcemaps
* HTML minification
* [Image minification](https://www.npmjs.com/package/gulp-imagemin)
* JS compilation
* [Babel](https://babeljs.io/) transpiler (ES6 support FTW)
* [SASS](http://sass-lang.com/) or [LESS](http://lesscss.org/) compilation
* Linting for [JS](https://www.npmjs.com/package/gulp-eslint), [SASS](https://www.npmjs.com/package/gulp-sass-lint) and [LESS](https://www.npmjs.com/package/gulp-lesshint)
* Desktop notifications on success and error
* [Fonticon](gulp-iconfont) generation
* [SVG Sprite](gulp-svgstore) generation
* Copy or Concat files
* Production mode: JS / CSS minification + sources maps removal
## Installation
```shell
npm install adfab-gulp-boilerplate --save
```
Upon installation, two files will be copied to the root of your project: `gulpfile.js` and `gulp-config.json`.
## Usage
### Configure the tasks you need
Every task rely on the `gulp-config.json` file for their configuration. Just fill-in the values you need.
* `vhost`: your local url,
* `sourceRoot`: root path where your assets will be stored
* `destinationRoot`: the path where your public final assets will be stored
* `tasks`: the list of all tasks you want to run. See details in `gulp-config.json` for details of every options of below for details about how it works
### Task config usage
A task uses somes common parameters:
* `source`: the source folder - a string or an array of string - relative to sourceRoot
* `destination`: the source folder - a string or an array of string - relative to destinationRoot
* `task`: the task you want to use, if the name is not the same as your task name
* `clean`: cleans destination folder of the task before copying files. So removed files from your source folder will be removed from destination folder too. default true
* `watch`: while using `gulp watch`or `gulp serve` your task source files will be watched by default. You can choose to watch other files for your task instead, or set to false to stop watching files for this task
Example:
```json
{
"fonts": {
"task": "copy",
"source": "fonts/",
"destination: "fonts/",
}
}
```
That task named `fonts` will execute the `copy` task which will copy files from your source folder to your destination folder. It will clean font folder every time a file is added/removed from source folder, and will be watched.
```json
{
"sassadmin": {
"task": "sass",
"source": ["sass/admin.scss"],
"watch": ["sass/**/*.scss"],
"destination": "admin/css",
"clean": false
}
}
```
That task named `sassadmin` will execute the `sass` task which will compile sass to css files from your source folder to your destination folder.
Destination folder wont be cleaned (as your admin css folder may contain other css files not manged by yourself).
The source file is only your admin css file, but every .scss file updated from your sass folder will be watched.
Many tasks have more options we will detail in `Task list overview` part.
### Add custom task / Override task
You can create a folder named `gulp-tasks` at the root of your project.
In this folder you can add new tasks. If a task has the same name as a default boilerplate task, it will override it.
## Task list overview
Every tasks has a desktop notification when succeeded or failed, with detailed logs.
Here is a list of current taks available:
* `copy`: copy files from your source folder to destination folder
* `concat`: copy files from your source folder to destination folder and concat them in a single file
* `sass`: to compile scss into css file, with autoprefixer, sourcemaps for development, minify for production
* `less`: as sass, but for less
* `sasslint`: checks your sass code
* `lesshint`: checks your less code
* `fonticon`: [fonticon](https://www.npmjs.com/package/gulp-iconfont) takes all svg files in a folder to create a fonticon and a [css/less/sass](https://www.npmjs.com/package/gulp-iconfont-css) file to be included in your final css
* `jslibs`: concatenates and uglify all your js libs into one single file
* `scripts`: parse your js with babelify for es6 compatibility. adds sourcemaps for dev, uglify for production
* `eslint`: checks your js code
* `views`: minify your html
* `images`: [images](https://www.npmjs.com/package/gulp-imagemin) optimizes image weight when copying
* `fonts`: juste copy your font files
* `svgsprite`: create a SVG sprite from all SVG files in a folder
## Gulp usage
### Build
You can use default task:
```shell
gulp
```
or
```shell
gulp build
```
To execute all the task listed in your `gulp-config.json` file in listed order.
### Single task
You can use:
```shell
gulp
```
To compile only a task fom your `gulp-config.json` file.
### Watch
You can use:
```shell
gulp watch
```
To build your tasks and watch for updates to compile files
### Browser live reloads
Using:
```shell
gulp serve
```
It start a [Browsersync](https://www.browsersync.io/) server.
It acts as a proxy to the domain you specified in `gulp-config.json` (property `vhost`). You can now access your project by specifying the `3000` port (if you usually access your project via `http://project.localhost/`, now it would be `http://project.localhost:3000/`).
You can also test it in production mode by passing the `--production` option. That way, it will remove *sourcemaps* and minify JS and CSS.
### Development and production
Development mode (by default), adds sourcemaps to your code for js/sass.
You can run:
```shell
gulp --production
```
It will remove sourcemap genreration and minify your js and css.
## License
[ISC license](https://github.com/AdFabConnect/adfab-gulp-boilerplate/blob/master/LICENSE).
Copyright (c) 2016-2018 ADFAB