# Financial Commons

> Common components, directives and helpers for Modyo financial widgets

![Publish Repo](https://github.com/modyo/financial-commons/workflows/Publish%20Repo/badge.svg?branch=2.0.0&event=release)
![Pull Request Lint Style](https://github.com/modyo/financial-commons/workflows/Pull%20Request%20Lint%20Style/badge.svg?branch=develop&event=pull_request)
![Pull Request Lint Javascript](https://github.com/modyo/financial-commons/workflows/Pull%20Request%20Lint%20Javascript/badge.svg?branch=develop&event=pull_request)
![Pull Request Test](https://github.com/modyo/financial-commons/workflows/Pull%20Request%20Test/badge.svg?branch=develop&event=pull_request)

## See it in action

 [storybook](https://modyo.github.io/financial-commons/)

## Getting started

1. Install package

    ```bash
    yarn add @modyo/financial-commons
    ```

2. Import it in your SFC

    ```javascript
    // example
    import {currency, MStepper} from '@modyo/financial-commons'
    ```

## Contribute

1. Project setup

    ```bash
    yarn install
    ```

2. Compiles and hot-reloads for development

    ```bash
    yarn serve
    ```

3. Run your unit tests

    ```bash
    yarn test:unit
    ```

4. Lints and fixes files

    ```bash
    yarn lint
    yarn lint:styles
    ```