Gulp Front

January 22, 2021 ยท View on GitHub

A lean and powerful, gulp-based boilerplate for better front-end coding with Gulp, Pug and Stylus

Build Status GitHub issues GitHub forks GitHub stars GitHub license Join the chat at https://t.me/gulpfront Join the chat at https://gitter.im/zoxon/gulp-front

Demo

zoxon.github.io/gulp-front

Documentation

More information see in docs folder

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

  2. Clone the project or download the file

    git clone git@github.com:zoxon/gulp-front.git --depth 1 my-project

  3. Go to project folder and run

    npm run setup

  4. Start dev server

    npm start

  5. In browser open page with address http://localhost:3000/

Main tasks

  • npm run dev - launches watchers and server
  • npm run build - compile a project
  • npm run zip - compile a project in zip
  • npm run deploy - compile a project and push in build branch to git repository
  • npm run cleanup - remove demo app

Module generator

Create empty module by name in source/modules folder

By default generate only *.pug and *.styl files.

You can call npm run new with additional params like js and yml

npm run new <module-name> [js || yml]

License

The MIT License (MIT)