exalate-kit v1.2.7-rc5

Exalate Kit

Exalate Kit is a library of React components.

WARNING!

The package is not stable yet, new minor and patch versions may change API. Use strict versioning in package.json.

Installation

The most common way to install the package is to use npm:

npm install --save exalate-kit

The other way is to use yarn:

yarn add exalate-kit

You can load Exalate Kit via <script> tag from a CDN. But in this case you also need to load peer dependencies from a CDN:

<script crossorigin src="https://unpkg.com/react@16/umd/react.development.js"></script>
<script crossorigin src="https://unpkg.com/react-dom@16/umd/react-dom.development.js"></script>
<script crossorigin src="https://unpkg.com/exalate-kit/dist/exalate-kit.js"></script>

and then access global variable exalateKit.

Development

First of all, you need to clone this repository locally:

git clone ssh://git@stash.idalko.com:7999/exapub/exalate-kit.git

Start

To open Storybook with a list of all components you need to run:

npm start

or

yarn start

it will automatically open localhost with running Storybook.

Test

To run tests you need to run the command:

npm test

or

yarn test

it will show the result in the console and make coverage folder with the coverage report.

ESlint

If you want to check all linting errors, just run:

npm run pretest

or

yarn pretest

Build

To create a build file you need to run:

npm run build

or

yarn build

it will create exalate-kit.js file in the dist folder.

License

Exalate Kit is Apache 2.0 licensed.