README.md

UI Kit

UI Kit is Sass toolkit and components library.

Table of Contents

• Requirements
• Quick Start
• Usage
• Documentation
• Recipes (FAQ)
• Troubleshooting
• Contributing
• History

---

Requirements

1. Git

2. Node 9.6.x

3. Grunt CLI

   npm install -g grunt-cli
   

Quick Start

1. Clone repo

2. Install dependencies

   npm install
   

3. Generate distribution

   npm start
   

Usage

You can find all available tasks in grunt/config/alias.coffee or by running grunt --help.

task	description
dist	Generate dist
fonts	Generate icon webfont from SVG files
images	Optimize images and copy them to dist
release	Generate CHANGELOG from Git commits, bump version and commit/tag/push it to repository
test	Run dummy test to hunt down Sass components compilation error(s)
watch	Watch source for changes and rebuild on change

Documentation

There's a living Styleguide aka UI Styleguide.

It's also recommended to check out the project Wiki.

Recipes (FAQ)

• How to release new version
• How to extend icon webfont
• How to process webfont

Troubleshooting

• Locking down package's dependencies

Contributing

See project CONTRIBUTING guide.

History

See project CHANGELOG to discover version changes.