Getting Started

Requirements

In order to compile the CSS and run the pattern library you will need Node.js installed. A good way to do this is to use Homebrew

Build & Development

Install the node packages using npm (comes with Node.js).

npm install

All the scripts for running the project can be found in Gruntfile.js. There are npm scripts for calling these in package.json.

Development

npm start

This will compile the CSS, static assets, run the Fractal server, watch for changes to the .scss files, and the static assets.

Build

npm run build

This will compile the CSS, image and font assets, and build a static version of the pattern library (builds to a patternlibrary directory).

npm run package

This will compile the CSS, image and font assets, and prepare the package for publication.

Versioning and Publishing

To automatically manage versioning and push to origin with git use the following commands.

Major

Major releases include backwards incompatible DOM changes, such as changes to class names or new DOM structures for modules.

npm run major

Minor

Minor releases include backwards compatible DOM changes, such as new modules or new x-selectors.

npm run minor

Patch

Patch releases include no DOM changes, such as a changes only to CSS.

npm run patch