@dvsa/smc-encounter-schema/README.md

Schemas required for Encounter submission as well as custom validators ## Developing ### Pre-requisites

# Encounter Schema

Schemas required for Encounter submission as well as custom validators
## Developing
### Pre-requisites

- Node.js (Please see `.nvmrc` for specific version)
- `npm` (If using [n](https://github.com/tj/n) or [nvm](https://github.com/nvm-sh/nvm), this will be automatically managed)
- Security
    - [Git secrets](https://github.com/awslabs/git-secrets)
    - [ScanRepo](https://github.com/UKHomeOffice/repo-security-scanner)
        - Unzip `repo-security-scanner_<version>_Darwin_<architercture>.tar.gz` and rename the executable inside the folder
          to `scanrepo` - Add executable to path (using `echo $PATH` to find your path)

### Getting started

###### Run the following command after cloning the project

1. `npm install` (or `npm i`)

###### The code that will be published lives inside the ./src directory.

To simplify the publishing step, each file must be exported from the `index.ts` file.

### Publishing

To see the output of what will be published, run the following command:

```shell
npm publish --dry-run
```