westfield_scally's Introduction

Overview

The Westfield Core CSS Framework (WFC) sits on top of our open source CSS framework Scally and is specific to Westfield, mostly based off this: http://styleguide.westfieldlabs.com/.

It follows the exact same architecture as Scally.

Think of WFC as the lick of paint and Scally as the scaffolding.

More documentation coming soon, in the meantime ask any questions in the Westfield Core Framework HipChat room or email any of the Westfield Labs front end engineers:

Use the repo's GitHub Issues to log any issues, additions, enhancements, or ideas.

Browser Support

IE9+.
Chrome.
Firefox.
Opera.
Safari (incl. iOS).
Android 3+.

Linting

To ensure a consistent authored code base and to keep things clean and readable WFC uses the scss-lint tool.

Installation and usage

To install run the following command:

gem install scss-lint

Which will install the Ruby Gem.

To use cd into your project's root and run the command:

scss-lint ./

Which will lint everything, to lint at a more granular level see.

Linting rules

WFC's linting rules can be found here. And WFC has a Rake test setup that'll run the scss-lint tool automatically to ensure no badly formatted CSS goes into the framework.