Git Product home page Git Product logo

motherplate's Introduction

Motherplate: A Responsive SCSS Boilerplate for Web Designers

Preview: http://leemunroe.github.io/motherplate/example.html

What is this?

This is a bare bones HTML/CSS framework I'll start off most web projects with.

It includes a CSS reset and a bunch of minimal boilerplate styles that should come in useful for any project, including a responsive grid, typography, icons and forms.

It is not as in depth as something like HTML5 Boilerplate and doesn't include styled components like Bootstrap.

It can be used for a static web project as is, or you can copy the CSS folder into an existing framework.

Using Motherplate for your project? Let me know so I can check it out.

Features

  • Uses SCSS partials to help structure the CSS.
  • Uses Compass to take advantage of CSS3 mixins so you don't have to worry about browser prefixes (-webkit- etc.).
  • Responsive-ready 12-column grid system to work across all devices.
  • Uses Font-Awesome icon fonts for icons.
  • Uses Normalize to reset browser styles.
  • Only enough CSS to get you started; minimal visual styling with this boilerplate.
  • Only the HTML/JS you need to get started; very little components with this boilerplate.

How to Use

This will vary depending on the framework you are using. The following is how to for a basic static website.

Install Ruby

Motherplate uses SASS and Compass, which rely on Ruby.

OSX comes pre-installed with Ruby but if you need to you can download ruby here.

Install the compass gem

Open up terminal (or command line) and install compass .

$ gem update --system
$ gem install compass

Download Motherplate

Download and copy the motherplate files into your new project folder.

Run compass watch

In terminal go to your project folder and run compass.

$ cd sites/mynewproject/
$ compass watch

Only edit the SCSS files

When you make changes to any of the scss files, your main.css file will be automatically updated. You don't edit main.css directly, compass takes care of that for you.

If you were working on a Rails project for example, you could just copy the files in the css folder to app/assets/stylesheets. The asset pipeline (and compass-rails gem) would take care of the rest.

HTML

A bare bones index.html template.

CSS

  • _config.scss Put all your variables in here e.g. colors, padding, border radius - this helps with consistency across your project.
  • _forms.scss Some basic form styles.
  • _grid.scss A basic responsive grid system with 12 columns.
  • _icons.scss This is Font Awesome's CSS stylesheet.
  • _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.
  • _links.scss Styles for any text links and/or buttons.
  • _media.scss Styles for images, video etc.
  • _mixins.scss Reusabled SASS mixins e.g. clearfix.
  • _notifications.scss Alerts to notify or give feedback to the user
  • _other.scss Small reusable other styles that don't fit the rest of the framework.
  • _print.scss Basic print stylesheets to make your pages look better when printed.
  • _reset.scss This is normalize.
  • _responsive.scss Add any responsive styles here e.g. hide elements, show elements, resize elements.
  • _shame.scss Keep this to hand for any quick and dirty CSS you need to add but plan to tidy later.
  • _tables.scss Styles for tables.
  • _type.scss Basic styling for your typography.
  • main.scss This brings all the partials together. Compass only compiles files that don't have an underscore

As your project grows and you need to add more styles just create new .scss files and reference them anywhere in your main.scss file.

Typical files I'll end up adding include _nav.scss, _home.scss.

JavaScript

  • I've included some basic Javascript including the latest jQuery and the document ready function.

Images

  • There is a /img folder for images.
  • For images referenced in the CSS I tend to keep them in the css/assets/ folder e.g. sp.png is a sprite I can reference.
  • Images referenced in the HTML are stored in the /img folder.

Fonts

  • Included font awesome for icons

Further Documentation

motherplate's People

Contributors

leemunroe avatar cluesang avatar

Watchers

Nolboo Kim avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.