Skip to content
This repository has been archived by the owner on Sep 16, 2024. It is now read-only.

chore(README): update readme #97

Merged
merged 2 commits into from
Jan 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,15 +98,40 @@ You can `cp .env.sample .env` and modify them locally.

Integration tests are used to validate endpoints and response payloads. Then can be run locally via:

1. Set `.env` to:

```shell
GATEWAY_HOST=localhost
GATEWAY_PORT=1984
GATEWAY_PROTOCOL=http
```

2. Run the service locally:

```shell
yarn start:watch
```

3. Run the integration tests:

```shell
docker compose up arns-service -d --build
yarn test:integration:local
```

or entirely via docker compose:

1. Update the `.env` file to (or remove it entirely):

```shell
GATEWAY_HOST=arlocal
GATEWAY_PORT=1984
GATEWAY_PROTOCOL=http
```

2. Spin up docker containers and run the integration tests:

```shell
yarn docker:integration
yarn test:docker
```

## Swagger
Expand Down
Loading