BC-4968 update README and add template env file

.gitignore

@@ -21,4 +21,5 @@ secrets
 .zshrc
 test-run-details.json
 cypress/fixtures/test-run-details.json
-configs
+configs
+!configs/template.env.json

README.md

@@ -21,7 +21,7 @@ Install or make sure Chrome browser (at least) have it in your development machi
 ### How to setup/run Cypress tests locally
 
 1) Clone the project
-2) Rename [`cypress.env.template.json`](/cypress.env.template.json) to `cypress.env.json` in the root folder with credentials available in 1Password.
+2) Rename [`template.env.json`](configs/template.env.json) to `local.env.json` in the configs folder with credentials available in 1Password. (Remember add all instances as in 1Password we have different vaults available)
 3) Execute the following command in terminal `npm install` or `npm i` for installing the required packages
 4) Execute the following command in terminal to run the tests in Cypress runner (UI) `npm run cy:open`
 5) Execute the following command in terminal to run the tests in headless mode `npm run cy:run`
@@ -37,6 +37,8 @@ Install or make sure Chrome browser (at least) have it in your development machi
 |   |____ manual-trigger.yml
 |   |____ scheduled-trigger.yml
 |---- .vscode (setting for VS code extensions)
+|---- configs
+|   |____ template.env.json (credentials & environment variables - rename the file as mentioned above)
 |---- cypress
 |   |___ downloads
 |   |___ fixtures
@@ -52,11 +54,13 @@ Install or make sure Chrome browser (at least) have it in your development machi
 |---- reports (containing html report & assets)
 |---- logs(contains logs of the test run)
 |---- node_modules
+|---- scripts
+|   |____ script.sh (scripts used in package.json)
+|   |____ set-env-vars.sh (set environment variables in CI)
 |---- .editorconfig
 |---- .gitattributes
 |---- .gitignore
 |---- reporter.js (for generating html reports)
-|---- cypress.env.template.json (credentials & environment variables - rename the file as mentioned above)
 |---- cypress.config.json (cypress related settings)
 |---- LICENSE
 |---- package-lock.json

configs/template.env.json

@@ -0,0 +1,66 @@
+{
+    "TEACHER_1_BRB_EMAIL": "",
+    "TEACHER_1_BRB_PASSWORD": "",
+    "TEACHER_1_BRB_FIRST_NAME": "",
+    "TEACHER_1_BRB_LAST_NAME": "",
+    "TEACHER_2_BRB_EMAIL": "",
+    "TEACHER_2_BRB_PASSWORD": "",
+    "TEACHER_2_BRB_FIRST_NAME": "",
+    "TEACHER_2_BRB_LAST_NAME": "",
+    "TEACHER_1_DBC_EMAIL": "",
+    "TEACHER_1_DBC_PASSWORD": "",
+    "TEACHER_1_DBC_FIRST_NAME": "",
+    "TEACHER_1_DBC_LAST_NAME": "",
+    "TEACHER_2_DBC_EMAIL": "",
+    "TEACHER_2_DBC_PASSWORD": "",
+    "TEACHER_2_DBC_FIRST_NAME": "",
+    "TEACHER_2_DBC_LAST_NAME": "",
+    "TEACHER_1_NBC_EMAIL": "",
+    "TEACHER_1_NBC_PASSWORD": "",
+    "TEACHER_1_NBC_FIRST_NAME": "",
+    "TEACHER_1_NBC_LAST_NAME": "",
+    "TEACHER_2_NBC_EMAIL": "",
+    "TEACHER_2_NBC_PASSWORD": "",
+    "TEACHER_2_NBC_FIRST_NAME": "",
+    "TEACHER_2_NBC_LAST_NAME": "",
+    "STUDENT_1_BRB_EMAIL": "",
+    "STUDENT_1_BRB_PASSWORD": "",
+    "STUDENT_2_BRB_EMAIL": "",
+    "STUDENT_2_BRB_PASSWORD": "",
+    "STUDENT_1_DBC_EMAIL": "",
+    "STUDENT_1_DBC_PASSWORD": "",
+    "STUDENT_2_DBC_EMAIL": "",
+    "STUDENT_2_DBC_PASSWORD": "",
+    "STUDENT_1_NBC_EMAIL": "",
+    "STUDENT_1_NBC_PASSWORD": "",
+    "STUDENT_2_NBC_EMAIL": "",
+    "STUDENT_2_NBC_PASSWORD": "",
+    "ADMIN_1_BRB_EMAIL": "",
+    "ADMIN_1_BRB_PASSWORD": "",
+    "ADMIN_1_DBC_EMAIL": "",
+    "ADMIN_1_DBC_PASSWORD": "",
+    "ADMIN_1_NBC_EMAIL": "",
+    "ADMIN_1_NBC_PASSWORD": "",
+    "EXPERT_1_BRB_EMAIL": "",
+    "EXPERT_1_BRB_PASSWORD": "",
+    "EXPERT_1_DBC_EMAIL": "",
+    "EXPERT_1_DBC_PASSWORD": "",
+    "EXPERT_1_NBC_EMAIL": "",
+    "EXPERT_1_NBC_PASSWORD": "",
+    "STUDENT_EXTERN_BRB": "",
+    "STUDENT_EXTERN_BRB_PASSWORD": "",
+    "STUDENT_EXTERN_DBC": "",
+    "STUDENT_EXTERN_DBC_PASSWORD": "",
+    "STUDENT_EXTERN_NBC": "",
+    "STUDENT_EXTERN_NBC_PASSWORD": "",
+    "STUDENT_BRB_PASSWORD_CHANGE_EMAIL": "",
+    "STUDENT_BRB_PASSWORD_CHANGE_OLD_PWD": "",
+    "STUDENT_BRB_PASSWORD_CHANGE_NEW_PWD": "",
+    "STUDENT_DBC_PASSWORD_CHANGE_EMAIL": "",
+    "STUDENT_DBC_PASSWORD_CHANGE_OLD_PWD": "",
+    "STUDENT_DBC_PASSWORD_CHANGE_NEW_PWD": "",
+    "STUDENT_NBC_PASSWORD_CHANGE_EMAIL": "",
+    "STUDENT_NBC_PASSWORD_CHANGE_OLD_PWD": "",
+    "STUDENT_NBC_PASSWORD_CHANGE_NEW_PWD": ""
+
+}