From ea140ac0b98a6dcf78aab3b6d01452a59735bc46 Mon Sep 17 00:00:00 2001 From: Kieran O'Neill Date: Mon, 18 Mar 2024 11:08:25 +0000 Subject: [PATCH] docs: update readme with new commands --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index baba805..5ccd9f1 100644 --- a/README.md +++ b/README.md @@ -100,10 +100,14 @@ This documentation outlines the available endpoints available. ### 3.2. Useful commands -| Command | Description | -|-------------------|------------------------------------------------------------------------------------------------------------------------------------------| -| `yarn setup` | Creates an `.env` file to the `.config/` directory. | -| `yarn start` | Runs setup and starts Docker Compose. Intended for development purposes only. | +| Command | Description | +|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| `yarn setup` | Creates an `.env` file to the `.config/` directory. | +| `yarn start` | Runs setup and starts Docker Compose. Intended for development purposes only. | +| `yarn test` | Runs the test script that starts up the Docker Compose test configuration and runs both unit and e2e tests. E2e tests require a running API and database. | +| `yarn test:e2e` | Runs the e2e tests (all files that are named `e2e.test.ts`). This command requires a running API at https://127.0.0.1:3000 and a database. | +| `yarn test:unit` | Simply runs the unit tests. These are self-contained and do not require any external dependencies. | + [Back to top ^][table-of-contents]