admireplate

A boiler plate for new sites


Keywords
sass, framework, boileplate, admireplate, grunt
License
QPL-1.0
Install
bower install admireplate

Documentation

Admireplate - Boilerplate

This is a MAMP specific boilerplate but can be adapted to your own needs.

Features

  • Uses SCSS partials to help structure the CSS.
  • Uses AutoPrefixer to take advantage of CSS3 declarations so you don't have to worry about browser prefixes (-webkit- etc.).
  • Gulp to take care of watching SASS, JS and minification.
  • BrowserSync to watch your magic come to life
  • Uses Normalize to reset browser styles.

Gulp

Gulp and BrowserSync will do the watching and production part of your website.

To use for sass watch

Open up terminal (or command line)

npm install

Then use 'gulp' in the command line to run the watch task along with BrowserSync.

Once you are ready to push live use 'gulp deploy' in the command line to run concatination and minification.

Bower

I use bower as a package manager, the only dependancy is jQuery currently, so upon clone use.

bower install

This will pull down jQuery. If you want to add more to your project just run

bower install *package* --save

CSS

Base

  • _animations.scss Put your CSS3 animations here.
  • _mixins.scss Reusable SASS mixins e.g. clearfix.
  • _print.scss Basic print stylesheets to make your pages look better when printed.
  • _reset.scss This is normalize.
  • _type.scss Basic styling for your typography.
  • _varibles.scss Put all your variables in here e.g. colors, padding, border radius - this helps with consistency across your project.

Layout

  • _grid.scss Place your grid here depending on project.
  • _ie.scss Any styles that you need to add in order for Internet Explorer to work.
  • _layout.scss This is where your main styles go. I typically have header, footer, logo classes here.
  • _shame.scss Keep this to hand for any quick and dirty CSS you need to add but plan to tidy later.
  • _site.scss Any site specific styles - keep this to smaller parts, anything that doesn't warrent it's own Ui file.

#Modules

  • _elements.scss All re-usable styles in here to keep to OOCSS - Remember DRY.
  • _forms.scss Some basic form styles.
  • _helper.scss Helper classes.
  • _icons.scss This is SVG icons
  • _links.scss Styles for any text links and/or buttons.
  • _notifications.scss Alerts to notify or give feedback to the user
  • _tables.scss Styles for tables.

#Ui

  • slideshow.scss All Ui specific styles go here in their own file. E.G - Slideshow

  • main.scss This brings all the partials together.

JavaScript

  • I've included some basic Javascript including the latest jQuery and the document ready function. You only need to edit /assets/js/src/global.js for your site styles. You would then put any plugins with-in /assets/js/libs.

While dev'ing locally on MAMP, you will need to add you plugins directly into the footer. Once running Gulp this will concat into one main.js file, but this is for go live only.

Further Documentation

Credit

Admireplate was originally based on Motherplate written by Lee Munroe.