Fed Pug Boilerplate readme

Generated on 2020-08-08 using generator-yeogurt@3.1.2

Description

This is an example readme file. Describe your site/app here.

Technologies used

JavaScript

• Browserifywith ES6/2015 support through Babel
• Node

Testing

• Karma
• Jasmine

Styles

• Sass via (node-sass)

Markup

• Pug

Optimization

• Imagemin
• Uglify

Server

• BrowserSync

Linting

• ESlint

Automation

• Gulp

Code Management

• Editorconfig
• Git

Automated tasks

This project uses Gulp and npm scripts (i.e. npm run...) to run automated tasks for development and production builds. The tasks are as follows:

npm run build: Build a production version of your site/app

npm run serve: Compiles preprocessors and boots up development server npm run serve -- --open: Same as npm run serve but will also open up site/app in your default browser npm run serve:prod: Same as npm run serve but will run all production tasks so you can view the site/app in it's final optimized form

npm test: Lints all *.js file in the source folder using eslint and runs all *.test.js file unit tests through Karma and Jasmine npm test -- --watch: Same as npm test but will constantly watch *.test.js files and rerun tests when changes are detected

Adding the -- --debug option to any npm script command to display extra debugging information (ex. data being loaded into your templates)