## README: @datr.tech/leith-common-mongodb-connector

> A Leith package containing a common mongodb connector - 0.4.0
---

### Install as dependency

Install from NPM using the following command.

```bash
npm i @datr.tech/@datr.tech/leith-common-mongodb-connector
```
---

### Install locally

Install the package from GitHub using the following commands.

```bash
git clone https://github.com/datr.tech/leith-common-mongodb-connector.git
```

Then install the required dependencies

```bash
cd @datr.tech/leith-common-mongodb-connector
npm i
```
#### Format

Format code, config files and (when applicable) tests

```bash
npm run format
```

The formatting will be performed by Prettier, and the associated Prettier config can be found [here][./.prettierrc.json].

#### Lint

Lint code, config files and (when applicable) tests

```bash
npm run lint
```

The formatting will be performed by EsLint, and the associated config can be found from the following address [./eslint.config.mjs][./eslint.config.mjs].