OCCAM Utils

Description

This is the API of OCCAM Utils.

Installation

To run this application you will need Node.js and Yarn installed on your machine. To install dependencies, you can run inside the root folder:

yarn

Running the app

To run the app locally in your machine, you can run the following command:

yarn start

Test and Lint

When you want to run tests locally. You can run the following command:

yarn test

# or if you want to run in watch mode
yarn test:watch

# or if you want to run coverage test
yarn test:cov

When you want to run lint locally. You can run the following command:

yarn lint

Documentation

You can find some additional information on how to work on this project:

• Create new commits
• Open Pull-Requests

Or you can see the full documentation guide here.