Documentation

Visit igloo.officevibe.design to learn more.

Usage

To use a component from this repo you will first need to install the component into your project.

For an example we will try to use the @igloo-ui/card component.

npm i @igloo-ui/card
# or with yarn
yarn add @igloo-ui/card

Then to use the component in your code just import it!

import Card from '@igloo-ui/card';

Getting Started

Before starting make sure node and yarn is installed

Install

After cloning ov-igloo-ui, run yarn to install dependencies.

git clone https://github.com/gsoft-inc/ov-igloo-ui.git
cd ov-igloo-ui
yarn
yarn storybook

Scripts

• yarn storybook: run Storybook
• yarn test: run tests
• yarn lint: check if the JS, TS correspond on standard
• yarn lint:style: check if the style correspond on standard

🤝 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.If you're interested, definitely check out our Contributing Guide!

License

Copyright © 2019, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.