# @treelab/common-logic [![npm version](https://badge.fury.io/js/@treelab%2Fcommon-logic.svg)](https://badge.fury.io/js/@treelab%2Fcommon-logic)

This library has been built using [TSDX](https://tsdx.io/).

It is a repository of business logic that can be shared between various projects
such as the [client](https://github.com/treelab/treelab-client/) and the [api](https://github.com/treelab/treelab-api/).

## Commands

```bash
# Install the dependencies
yarn

# Run the tests
yarn test

# Build the project in watch mode to `/dist`
yarn start

# Do a one-off build to `/dist`
yarn build
```

## Contributing

This project uses `prettier` and `eslint` for styling. Please ensure you have
the appropriate editor extensions installed.

This project keeps a very high bar for testing. If you are committing or
updating logic in this project, you should be adding or updating test cases.

## Publishing to NPM

Please use the [Create new release and publish to npm](https://github.com/treelab/treelab-panda-v3/actions/workflows/npm-publish.yml) GitHub action.