living-style-guide

RA-TES Style Guide

A CSS Framework for building awesome line-of-business web apps based on material design and Materialize.

Contributing

Feel free to open an issue, or file a pull-requests if you see there are any issues or improvements we should make. We value all contributions (not just code) so also improvements to documentation & guidelines.

How to: use this style guide in your project

• Perform yarn add living-style-guide to add this repository to your package.json
• Make use of the styleguide by connecting the css file with import 'living-style-guide/bin/materialize.css' in any javascript file
• You need import the file only once

How to: develop the style guide on your local machine

• Install NodeJs
• Install Git
• Install Yarn
• Create a local folder where you want to install your files.
• Go to Git repository and copy the URL (top right of the page)
• Open command line in your folder of choice: git clone https://github.com/ra-tes/style-guide.git
• Go to the tes-styleguide folder in your root folder using commandline
• Run the command: yarn add grunt -g
• Run the command: yarn install
• Run the command: yarn run dev
• Open the site: localhost:8000

Supported Browsers:

Chrome 35+, Firefox 31+, Safari 7+, IE 10+

Testing

We use Jasmine as our testing framework and we're trying to write a robust test suite for our components. If you want to help, here's a starting guide on how to write tests in Jasmine