diff --git a/README.md b/README.md index fa2d87e..f625e86 100644 --- a/README.md +++ b/README.md @@ -161,7 +161,7 @@ npm run migration:run > ### Docker Compose -Run our `infrastructure` with `docker` using the [infrastructure.yaml](./deployments/docker-compose/infrastructure.yaml) file with the below command at the `root` of app: +Use the command below to run our `infrastructure` with `docker` using the [infrastructure.yaml](./deployments/docker-compose/infrastructure.yaml) file at the `root` of the app: ```bash docker-compose -f ./deployments/docker-compose/infrastructure.yaml up -d @@ -170,30 +170,28 @@ docker-compose -f ./deployments/docker-compose/infrastructure.yaml up -d I will add `docker-compsoe` for up and running whole app here in the next... > ### Build -For `building` each microservice, Run this command in root of each microservice where `package.json` located: +To `build` each microservice, run this command in the root directory of each microservice where the `package.json` file is located: ```bash npm run build ``` > ### Run -For `runing` each microservice, Run this command in root of each microservice where `package.json` located: +To `run` each microservice, run this command in the root of the microservice where `package.json` is located: ```bash npm run dev ``` > ### Test -For `testing` each microservice, Run this command in root of each microservice where `package.json` located: +To `test` each microservice, run this command in the root directory of the microservice where the `package.json` file is located: ```bash npm test ``` - > ### Documentation Apis -Each microservice uses swagger open api, navigate to `/swagger` for getting the list endpoints. - -Also, to test apis, I created the [booking.rest](./booking.rest) file. This file run with [REST Client](https://github.com/Huachao/vscode-restclient) `VSCode plugin`. +Each microservice has a `Swagger OpenAPI`. Browse to `/swagger` for a list of endpoints. +As part of API testing, I created the [booking.rest](./booking.rest) file which can be run with the [REST Client](https://github.com/Huachao/vscode-restclient) `VSCode plugin`. # Support