/SASS-Material-Design-for-Bootstrap

Extends Bootstrap with Google Material Design concepts.

Primary LanguageCSSMIT LicenseMIT

SASS Material Design for Bootstrap

Build Status

Introduction

The purpose of this repository is to extend, within Bootstrap, the options available to the developer / designer in line with the Google Material Design concepts.

View the preview site

Installation

Install Grunt, SASS, Jekyll and Bower if you need them then install bower components

npm install -g grunt-cli
gem install sass
gem install jekyll
npm install -g bower
bower install

Install Grunt, required plugins and update NPM:

npm install grunt --save-dev
npm install grunt-contrib-sass --save-dev
npm install grunt-contrib-watch --save-dev
npm install grunt-contrib-uglify --save-dev
npm install grunt-contrib-cssmin --save-dev
npm install grunt-contrib-copy --save-dev
npm install grunt-contrib-imagemin --save-dev
npm install grunt-jekyll --save-dev
npm install grunt-concurrent --save-dev
npm install grunt-sketch --save-dev
npm update -g

You will also need to download the latest Sketch Tool, unzip it and run the ./install.sh

Run Grunt:

grunt

Grunt will then watch concurrently for changes to docs, js and scss files and build each as required.

Documentation

The documentation is generated using Jekyll and resides in the docs directory. When you run grunt we automatically set up a Jekyll server locally with the docs running.

Any changes to the source files we be built and the local docs will be updated.

Links

Bootstrap, Google Material Design