From 5fff1756dafdbe71cf3eef6948f8483781975dcc Mon Sep 17 00:00:00 2001 From: dtfiedler Date: Thu, 18 Jan 2024 11:21:49 -0700 Subject: [PATCH] chore(README): update readme --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8aa3f3e..245895e 100644 --- a/README.md +++ b/README.md @@ -98,15 +98,30 @@ 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: ```shell -yarn docker:integration +yarn test:docker ``` ## Swagger