Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.28 KB

README.md

File metadata and controls

29 lines (20 loc) · 1.28 KB

Bagel Boilerplate

Bagel requires node v0.10 and Sass >=v3.3


Getting started

npm install && grunt

This will download bagel-core, which in turn downloads bagel-functions, bagel-layout, and bagel-abstractions.

By their powers combined, you get a base Sass authoring framework (resusable mixins, layout utility helpers, and structural abstractions), a set of base components (from buttons to inputs to dropdowns), a base prototype theme for those components to allow rapid UI prototyping, and a methodology for creating your own themes/chrome.

Configuration

Values in config.yml allow you choose exactly what you want from each layer as well as set sizing variables to be used throughout.

Guide

By default, bagel-boilerplate will use the styleguide documentation from bagel-core. Overrides to any styleguide document can be made by creating your own file in guide/. See bagel-core guides for examples.

Mockups

Mockups can be created directly in bagel via mockups/. As with guides/, we use Assemble under the hood.