Skip to content

Commit

Permalink
chore: lint
Browse files Browse the repository at this point in the history
  • Loading branch information
Fdawgs committed Jan 11, 2025
1 parent 302130a commit 55899fa
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ When you submit pull requests, please make sure to fork from and submit back to

Other processes and specifications that are in use in this repository are:

- [Semantic versioning](https://semver.org/)
- [Conventional commits](https://conventionalcommits.org/en/v1.0.0/) following the [@commitlint/config-conventional config](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)
- [Prettier](https://prettier.io/) style guide
- [Semantic versioning](https://semver.org/)
- [Conventional commits](https://conventionalcommits.org/en/v1.0.0/) following the [@commitlint/config-conventional config](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)
- [Prettier](https://prettier.io/) style guide

## Getting started

Expand All @@ -24,16 +24,16 @@ Make a copy of `.env.template` in the root directory and rename it to `.env`, co

After cloning the repository and installing all the dependencies, there are several commands available for local development:

- `npm run build` - Runs esbuild to compile code into dist directory
- `npm run lint` - Runs [ESLint](https://eslint.org) over all support file types
- `npm run lint:prettier` - Runs [Prettier](https://prettier.io) over all supported file types
- `npm run jest` - Runs [Jest](https://jestjs.io) tests in src directory
- `npm test` - Runs all of the above linting and testing scripts together
- `npm run start:dev` - Starts a development server with live reload
- `npm run build` - Runs esbuild to compile code into dist directory
- `npm run lint` - Runs [ESLint](https://eslint.org) over all support file types
- `npm run lint:prettier` - Runs [Prettier](https://prettier.io) over all supported file types
- `npm run jest` - Runs [Jest](https://jestjs.io) tests in src directory
- `npm test` - Runs all of the above linting and testing scripts together
- `npm run start:dev` - Starts a development server with live reload

### Production workflow

- `npm start` - Runs a production version. No live reload
- `npm start` - Runs a production version. No live reload

## Documentation style

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ Docsmith enables a data processor to use a comprehensive, GDPR-compliant, open-s

These are only required if running the API outside of Docker:

- [Node.js](https://nodejs.org/en/) >=20.0.0
- Linux only: `poppler-data` >=0.4.9
- Linux only: `poppler-utils` >=20.12.0
- macOS only: `poppler` >=20.12.0
- Linux and macOS only: `unrtf` >=0.19.3
- [Node.js](https://nodejs.org/en/) >=20.0.0
- Linux only: `poppler-data` >=0.4.9
- Linux only: `poppler-utils` >=20.12.0
- macOS only: `poppler` >=20.12.0
- Linux and macOS only: `unrtf` >=0.19.3

## Setup

Expand All @@ -59,9 +59,9 @@ Perform the following steps before deployment:
> **Note**
> Set the following environment variables in `.env` to meet NHS England's recommendation to retain six months' worth of logs:
>
> - `LOG_ROTATION_DATE_FORMAT="YYYY-MM-DD"`
> - `LOG_ROTATION_FREQUENCY="daily"`
> - `LOG_ROTATION_MAX_LOGS="180d"`
> - `LOG_ROTATION_DATE_FORMAT="YYYY-MM-DD"`
> - `LOG_ROTATION_FREQUENCY="daily"`
> - `LOG_ROTATION_MAX_LOGS="180d"`
## Deployment

Expand Down

0 comments on commit 55899fa

Please sign in to comment.