Volosojui/project-starter

Project template for static site (Gulp 4 + Webpack 4)

Project Starter Kit (gulp 4, webpack 4, pug, sass)

Project template for static site

Installation

Firstly, clone the project starter kit

git clone git@github.com:Volosojui/project-starter.git project-folder-name && cd project-folder-name

then install all the packages using npm

npm ci

or using yarn

yarn

Run

Run with change tracking in realtime (html, css, js, iconfont).

This mode generates sourcemaps for styles and scripts, so you can always easily debug your code

npm run start

or using yarn

yarn start

Compiles all files to folder build (no minification)

npm run build

or using yarn

yarn build

Compiles all files to production folder dist (with minification)

npm run build:prod

or using yarn

yarn build:prod

Deploy build version to gh-pages

npm run deploy

or using yarn

yarn deploy

Deploy production version to gh-pages

npm run deploy:build:prod

or using yarn

yarn deploy:build:prod

Inline svg sprite

If you would like to use this feature, you should:

1. add any svg icon inside svgicons folder
2. then uncomment the following lines:

in layout.pug:

.svg-store
  include ./../../svgicons/svgicons.svg

in _bundle.scss:

@import 'partials/svg-store';
@import 'partials/svg-icon';

! If you skip the first step, you will get an error in the console

Browser suppport

> 0.25%
not dead

Environments

node >= 14