From 3a1df8cf5179e2170d247cb5cacc01d270e30385 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roberto=20Garc=C3=ADa=20=C3=81lvarez?= Date: Mon, 30 Jan 2023 08:56:04 +0100 Subject: [PATCH] Create a Environment requirements section Card https://github.com/alastria/alastria-identity-example/issues/136 is made where it is explained the need to create a section with the requirements of the environment for the successful execution of the examples. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 918567f..dbdd70f 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,31 @@ tsc |exampleAuthentication| It contains an example of how authentication is done |[Wiki](https://github.com/alastria/alastria-identity-example/wiki/Authentication-example) |keystores| Contains the mocked keystores that we used to create the identities with different roles. These roles are explained [here](/keystores/README.md) | +## Environment requirements +**This section specifies the environment requirements for the successful execution of the examples.** + +First of all, to avoid possible errors with node and npm, it is recommended that the installation is done through **Nvm**. + +Once you have **Nvm installed**, all you need to do is install the required version of node with . +```sh +nvm install +``` + +On the other hand, if any problem persists, it is recommended to **clean the npm cache** with the following command +```sh +npm cache clean -f +``` + +The list of Npm and Node versions that have worked for the different members of the core identity team are listed below. +|**Versions**|**Does it work?**| +|:--|:--| +|Node 14.19.0 && Npm 6.14.16|**OK**| +|Node 14.20 && Npm 6.14.17|**OK**| +|Node 14.20.1 && Npm 6.14.17|**OK**| +|Node 16.13.0 && Npm 8.15.0|**OK**| +|Node 16.13.2 && Npm 8.1.2|**OK**| +|Node 16.14 && Npm 8.3.1|**OK**| ## How to use it