/frontend-boilerplate

Easy to use boilerplate for your front-end project.

Primary LanguageJavaScript

Front-end boilerplate (Gulp, Nunjucks, BrowserSync, SASS, SVG embed)

Easy to use boilerplate for your front-end project.

Boilerplate's main features:

  • Gulp - for automated tasks
  • BrowserSync - for local development server
  • Nunjucks - for templating (HTML)
  • SVG embed - automated SVG conversion from <img class="sprite" src="sprite.svg" /> to <svg class="sprite">

Install

Assuming that you have Node.js already installed follow these steps to install this repository on your machine:

  1. git clone https://github.com/richardevcom/front-end-boilerplate.git - Clone this repository
  2. npm install - Install node modules
  3. That's it. If you like to change the directory names & locations, don't forget to change the paths in ./config.js also.

Run

  • npm run build or gulp build - Build distribution files
  • npm run dev or gulp dev - Run development environment & build on changes
  • npm run clean or gulp clean - Clean distribution folder

To use gulp commands, you have to npm install --global gulp-cli.