<commit_before># Gulp Front

English description | [Описание на русском](README_RU.md)

*A lean and powerful, gulp-based boilerplate for better front-end coding with [Gulp](http://gulpjs.com/), [Pug](https://pugjs.org/) and [Stylus](https://learnboost.github.io/stylus/)*

[![Build Status](https://travis-ci.org/zoxon/gulp-front.svg?branch=master)](https://travis-ci.org/zoxon/gulp-front/builds)
[![devDependency Status](https://david-dm.org/zoxon/gulp-front/dev-status.svg)](https://david-dm.org/zoxon/gulp-front?type=dev)
[![GitHub issues](https://img.shields.io/github/issues/zoxon/gulp-front.svg?style=flat)](https://github.com/zoxon/gulp-front/issues)
[![GitHub forks](https://img.shields.io/github/forks/zoxon/gulp-front.svg?style=flat)](https://github.com/zoxon/gulp-front/network)
[![GitHub stars](https://img.shields.io/github/stars/zoxon/gulp-front.svg?style=flat)](https://github.com/zoxon/gulp-front/stargazers)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/zoxon/gulp-front/blob/master/LICENSE)
[![Join the chat at https://gitter.im/zoxon/gulp-front](https://img.shields.io/badge/gitter-join%20chat-green.svg?style=flat)](https://gitter.im/zoxon/gulp-front?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Demo
[zoxon.github.io/gulp-front](http://zoxon.github.io/gulp-front/)

## Core features

* Modern and fast build tool
* Module based BEM CSS framework
* Automatic icon system based on SVG Symbols
* Easy PNG Sprites generation (including @2x)
* A convenient @media mixins
* Smart image compression

## Quick start

* Install the [node.js](https://nodejs.org)
* Clone the project or [download](https://github.com/zoxon/gulp-front/archive/master.zip) the file

	```bash
	git clone <EMAIL>:zoxon/gulp-front.git my-project && cd my-project
	```

* For [Yarn](https://yarnpkg.com)
	- Install `gulp-cli` globally (once!)

		```bash
		yarn global add gulp-cli
		```

	- Install dependencies

		```bash
		yarn
		```

	- Start `gulp`

		```bash
		yarn start
		# or
		yarn dev
		```

* For [NPM](https://www.npmjs.com)
	- Update npm to latest version
		Go to the folder with installed nodejs

		```bash
		cd "C:\Program Files\nodejs"
		```

		or

		```bash
		cd "C:\Program Files (x86)\nodejs"
		```

		and execute

		```bash
		npm install npm@latest
		```

	- Install `gulp-cli` globally (once!)

		```bash
		npm install gulp-cli -g
		```

	- Install dependencies

		```bash
		npm install
		```

	- Start `gulp`

		```bash
		npm start
		```

* In browser open page with address [`http://localhost:3000/`](http://localhost:3000/)


## Main tasks

For npm use `npm run <command>`, for Yarn use `yarn <command>`

* `dev` - launches watchers and server
* `build` - compile a project
* `zip` - compile a project in zip
* `deploy` - compile a project and push in `build` branch to git repository
* `remove-demo` - remove demo app

## Module generator

There is a script for add/delete modules in project in gulp-front.

For npm use `npm run <command>`, for Yarn use `yarn <command>`

* `amo <moduleName>` - creates an empty module with a help of technologies, such as pug and styl;
* `amo <moduleName> js yml` - creates an empty module with a help of pug and styl and also using additional technologies: js, yml and json;
* `rmo <moduleName>` - Use to delete a module.

Examples: `npm run amo my-module yml js`, `yarn amo my-other-module`


## Files and folders structure

```
gulp-front/                             # Project root
├── dest                                # Compiled files
├── source                              # Source files
│   ├── modules                         # Modules folder
│   ├── pages                           # Pages
│   └── static                          # Static files
│       ├── assets                      # Other files
│       ├── scripts                     # JavaScript files
│       │   ├── plugins                 # JavaScript plgins and libs
│       │   ├── main.js                 # Main JavaScript file
│       │   └── plugins.js              # Plugins assemblage file
│       └── styles                      # Static styles
│           ├── components              # Componetns
│           ├── plugins                 # Plugins styles
│           ├── _common.styl            # Different styles
│           ├── _media.styl             # @media
│           ├── _variables.styl         # Variables
│           ├── main.styl               # Main styles
│           └── reset.styl              # Styles reset + typography
├── tmp                                 # Temp folder
├── zip                                 # Folder with zip archives
├── package.json                        # Dependencies for node.js
├── .csscomb.json                       # csscomb config
├── .editorconfig                       # EditorConfig
├── .travis.yml                         # TravisCI config
├── gulpfile.js                         # gulp.js config
├── LICENSE                             # License
└── README.md                           # File you read
```

## License
[The MIT License (MIT)](LICENSE)
<commit_msg>Update main README.md file<commit_after># Gulp Front

English description | [Описание на русском](README_RU.md)

*A lean and powerful, gulp-based boilerplate for better front-end coding with [Gulp](http://gulpjs.com/), [Pug](https://pugjs.org/) and [Stylus](http://stylus-lang.com/)*

[![Build Status](https://travis-ci.org/zoxon/gulp-front.svg?branch=master)](https://travis-ci.org/zoxon/gulp-front/builds)
[![devDependency Status](https://david-dm.org/zoxon/gulp-front/dev-status.svg)](https://david-dm.org/zoxon/gulp-front?type=dev)
[![GitHub issues](https://img.shields.io/github/issues/zoxon/gulp-front.svg?style=flat)](https://github.com/zoxon/gulp-front/issues)
[![GitHub forks](https://img.shields.io/github/forks/zoxon/gulp-front.svg?style=flat)](https://github.com/zoxon/gulp-front/network)
[![GitHub stars](https://img.shields.io/github/stars/zoxon/gulp-front.svg?style=flat)](https://github.com/zoxon/gulp-front/stargazers)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/zoxon/gulp-front/blob/master/LICENSE)
[![Join the chat at https://gitter.im/zoxon/gulp-front](https://img.shields.io/badge/gitter-join%20chat-green.svg?style=flat)](https://gitter.im/zoxon/gulp-front?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Demo
[zoxon.github.io/gulp-front](http://zoxon.github.io/gulp-front/)

## Documentation

[Documentation](docs/README.md)

## Core features

* Modern and fast build tool
* Module based BEM CSS framework
* Automatic icon system based on SVG Symbols
* Easy PNG Sprites generation (including @2x)
* A convenient @media mixins
* Smart image compression

## Quickstart

1. Install the [node.js](https://nodejs.org)
2. Clone the project or [download](https://github.com/zoxon/gulp-front/archive/master.zip) the file
	```sh
	git clone <EMAIL>:zoxon/gulp-front.git --depth 1 my-project
	```
3. Install `gulp-cli` globally (once!)
	```sh
	npm install gulp-cli -g
	```
4. Install dependencies
	```bash
	npm install
	```
5. Start `gulp`
	```bash
	npm start
	```
6. In browser open page with address [`http://localhost:3000/`](http://localhost:3000/)


## Main tasks

For npm use `npm run <command>`, for Yarn use `yarn <command>`

* `dev` - launches watchers and server
* `build` - compile a project
* `zip` - compile a project in zip
* `deploy` - compile a project and push in `build` branch to git repository
* `remove-demo` - remove demo app

## Module generator

There is a script for add/delete modules in project in gulp-front.

For npm use `npm run <command>`, for Yarn use `yarn <command>`

* `amo <moduleName>` - creates an empty module with a help of technologies, such as pug and styl;
* `amo <moduleName> js yml` - creates an empty module with a help of pug and styl and also using additional technologies: js, yml and json;
* `rmo <moduleName>` - Use to delete a module.

Examples: `npm run amo my-module yml js`, `yarn amo my-other-module`


## Files and folders structure

```
gulp-front/                             # Project root
├── dest                                # Compiled files
├── docs                                # Documentation
├── gulp                                # Gulpfile tasks and config
├── source                              # Source files
│   ├── modules                         # Modules folder
│   ├── pages                           # Pages
│   └── static                          # Static files
│       ├── assets                      # Other files
│       ├── icons                       # SVG icons files
│       ├── public                      # Root files
│       ├── scripts                     # JavaScript files
│       │   ├── helpers                 # JavaScript helpers
│       │   ├── plugins                 # JavaScript plgins and libs
│       │   ├── main.js                 # Main JavaScript file
│       │   └── vendor.js               # Plugins assemblage file
│       └── sprite                      # PNG Sprite files
│       └── styles                      # Static styles
│           ├── components              # Componetns
│           ├── plugins                 # Plugins styles
│           ├── templates               # Sysytem used templates
│           ├── _common.styl            # Different styles
│           ├── _variables.styl         # Variables
│           ├── main.styl               # Main styles
│           └── reset.styl              # Styles reset + typography
├── tmp                                 # Temp folder
├── tools                               # Gulp-front tools
├── zip                                 # Folder with zip archives
├── .babelrc                            # Babel config file
├── .browserslistrc                     # Browserlist config
├── .editorconfig                       # EditorConfig
├── .eslintrc.json                      # ESLint config
├── .gitignore                          # Files ignored by GIT
├── .htmlhintrc                         # Settings for HTMLHint
├── .npmignore                          # Files ignored by npm
├── .postcss-sorting.json               # postcss-sorting config
├── .travis.yml                         # TravisCI config
├── gulpfile.babel.js                   # gulp.js config
├── LICENSE                             # License
├── package.json                        # Dependencies for node.js
├── postcss.config.js                   # PostCSS config
├── README.md                           # English readme file
├── README_RU.md                        # Russian readme file
├── webpack.config.babel.js             # Webpack config
└── yarn.lock                           # YARN Lock file
```

## License
[The MIT License (MIT)](LICENSE)

{'fraction_non_alphanumeric': 0.13408440299196603, 'fraction_numerical': 0.0028626835349524426, 'mean_word_length': 2.0610514414923684, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 39, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 11, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '586315', 'n_tokens_mistral': 3598, 'n_tokens_neox': 3394, 'n_words': 921}