This repository contains the files for a default HTML boilerplate.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. Also note that we use command line over SSH and Git for these instructions. There are many ways to go about setting this up but this is my preferred method (excluding batch scripts).

What things you need to install the software and how to install them:

Node.js

A step by step series of examples that tell you how to get a local development environment running. We assume you have MAMP or similar installed. If not, you may install it here.

Command line into the root of your installation and do the following to install the boilerplate:

First, you will clone/download the boilerplate from the repository:

git clone [email protected]:stesab92/HTML-Boilerplate.git .

Then, you will initialize the repository:

git init

Then, you will install dependencies:

npm install

In this project we use Node.js and Gulp to compile our assets and manage our dependencies.

gulp - Runs all of the compiler and watch tasks in parallel. (default)
gulp run - Runs all of the compiler tasks in parallel.
gulp watch - Runs all of the watch tasks in parallel.
gulp clean - Deletes any files or folders output by the compiler for a clean start. (index.js, index.min.js, index.css, index.min.css, compiled images)
gulp sass - Compile SCSS to CSS and combine files to style.css and style.min.css (minified).
gulp js - Compile JS and combine files to script.js and script.min.js (minified).
gulp images - Optimize any new images in the src/images directory to images.
gulp watch:sass - Monitor src/scss directory and run sass task on change.
gulp watch:js - Monitor src/js directory and run js task on change.
gulp watch:images - Monitor src/images directory and run images task on change.

• Browserl.ist

• HTML5 - Frontend Markup Language
• CSS3 - Frontend Stylesheet Language
• SASS - Backend Stylesheet Language
• Node.js - Dependency Management
• Gulp - Asset Compiler

We use SemVer for versioning. For the versions available, see the tags on this repository.

We use Sass Guidelines for structuring our SASS files.

• Stephen Sabatini

This is free software, and is released under the terms of the GNU General Public License (GPL) version 2. See the LICENSE.md file for details

• Hat tip to anyone whose code was used
• Inspiration
• etc