Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/htanjo/gulp-boilerplate
Boilerplate for gulp project.
https://github.com/htanjo/gulp-boilerplate
Last synced: about 1 month ago
JSON representation
Boilerplate for gulp project.
- Host: GitHub
- URL: https://github.com/htanjo/gulp-boilerplate
- Owner: htanjo
- License: mit
- Created: 2015-09-30T08:58:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-09T06:33:01.000Z (almost 9 years ago)
- Last Synced: 2023-03-23T17:52:48.840Z (almost 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 381 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gulp Boilerplate
> Boilerplate for gulp project.
## Features
- **Stylesheet**
- [Sass](http://sass-lang.com/)
- [Autoprefixer](https://github.com/postcss/autoprefixer)
- **JavaScript**
- [ESLint](http://eslint.org/)
- [Browserify](http://browserify.org/)
- **Web performance**
- HTML/CSS/JS minification
- Image optimization
- Static asset revisioning
- **Automation**
- CSS Sprites generator
- Icon fonts generator
- Deployment to Git repository
- **Development server**
- [Browsersync](https://www.browsersync.io/)
## Getting started
Make sure to install [Node.js](https://nodejs.org/).
### Install dependencies
```sh
$ npm install
```
This installs both build system modules and dependent libraries for the project.
### Start development
```sh
$ npm start
```
This starts local development server and "watch" tasks.
When you save a source code, it will be compiled and reload browser automatically.
## Structure
```
gulp-boilerplate/
├── app/ : Application files
│ ├── styles/ : Stylesheets
│ ├── scripts/ : Scripts
│ ├── images/ : Images
│ │ └── _sprites/ : Base images for spritesheet
│ ├── fonts/ : Web fonts
│ │ └── _glyphs/ : Base SVG files for icon font
│ └── index.html : Index page
├── dist/ : Production files (Not tracked in Git)
├── tasks/ : Additional gulp tasks
├── gulpfile.js : Base gulp config
└── package.json : Package information including dependencies
```
## Build tasks
- **`npm start`**
Start local development server and watch files to compile/lint.
[Cntl + C] to exit.
- **`npm test`**
Run linter.
- **`npm run build`**
Run linter and build app for production.
- **`npm run serve:dist`**
Start server with production files.
- **`npm run deploy`**
Deploy production files to `gh-pages` branch.
## License
Copyright (c) 2015-2016 Hiroyuki Tanjo.
Licensed under the [MIT License](LICENSE).