setup.md

Setup

This is what you need to install:

• NodeJS v12 or higher

Then open a shell and clone the repository to your local machine.

To ensure everything is working, run this command from the root of the repository:

yarn

This will install the dependencies, compile the library source and run the suite of tests.

Coding Style

The coding style is based on Prettier and can be validated from the command line:

yarn is-it-pretty

To ensure your changes match the formatting, just run this before committing:

yarn prettify

Or add prettier integration for your editor for first-class support.