Skip to content

A solid boilerplate to help you get up and running in a new project

License

Notifications You must be signed in to change notification settings

foxlab/boilerplate

 
 

Repository files navigation

Build Status devDependency Status

Boilerplate for your projects made with Grunt, Sass, Jeet.gs and Browserify.

Features

  • No styling at all, this is a completely bare boilerplate containing only the essential things you need
  • A solid Sass and Javascript foundation
  • Includes Browserify to handle Javascript dependencies
  • Includes Normalize.css to make browser rendering more consistent
  • Includes jQuery and Modernizr
  • CSS helper classes
  • A performance optimized print CSS from HTML5BP
  • Commonly used CSS components such as the Media Object and the Flag Object
  • A Gruntfile with super fast Javascript and Sass compilation/concatenation
  • Grid system from Jeet.gs
  • Component based file and folder structure, to help create re-usable and maintainable CSS
  • A Sass library of commonly used mixins and placeholder selectors

Download

  • Download the latest release
  • Clone the repo: git clone https://github.com/sebastianekstrom/boilerplate.git
  • Install with Bower: bower install Z63-Boilerplate

Getting started

Step 1. Install NodeJS

Step 2. Install Grunt CLI

npm install -g grunt-cli

Step 3. Install the npm dependencies

cd path/to/project
npm install

Step 4. Run Grunt's default task

grunt

Grunt tasks

There are two Grunt tasks; grunt and grunt dist.

grunt is the default task and will concatenate all Javascript files in to dist/js/script__1.7.0.js as well as running JSHint on them. The task will also concatenate all Sass files into dist/css/style__1.7.0.css and also run autoprefixer on the outputted CSS file to ensure all the correct vendor prefixes are included. grunt also uses the grunt watch task, so it automatically runs every time a JS/SCSS file changes.

grunt dist is the production task and will do everything the default task does, as well as compressing the JS and CSS files.

License

The code is available under the MIT license.

About

A solid boilerplate to help you get up and running in a new project

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 84.4%
  • CSS 15.4%
  • HTML 0.2%