diff --git a/README.md b/README.md index 36f62db..24edbeb 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,22 @@ # About lifen-postman -This repository holds some PostMan files that performs tests against Lifen's Fhir API. They represent my handout regardinf the technical test. +This repository holds some PostMan files that performs tests against Lifen's Fhir API. They represent my handout regardinf the technical test. There is also a Node programm that run `NewMan`. -## Installation and execution +## Installation and execution via CLI + +NodeJs 16+ is required. + +1. Clone this repository on your local computer +2. Open your favorite IDE, VSC or a terminal +2. Purge the `node_modules` folder (`rm -rf ./node_module/*`) +3. Install `NewMan` via npm with the command `npm install`. It will lookup eveything based on the `package.json` file. +4. Run newman via the npx command `npx newman run .\lifen-api.postman_collection.json -e '.\fhir-api public post-prod.postman_environment.json'` + +### An example of NewMan's test report + +![An example of NewMan's test report](./public/newman-testresult-example.jpg) + +## Installation and execution in the PostMan GUI PostMan is required to run them. @@ -20,7 +34,7 @@ PostMan is required to run them. * There is no need to save the cookies, as there will be no cookies backed here 😔🍪 ![a runner in PostMan](./public/lifen-api-runner.jpg) -## an Example of Test Report in PostMan +### an Example of Test Report in PostMan ![an Example of Test Report](./public/run-result-example.jpg)