diff --git a/README.md b/README.md index 5f3c7558..023244c4 100644 --- a/README.md +++ b/README.md @@ -9,18 +9,19 @@ Frameworks: ### Prepare development environment Install or make sure Chrome browser (at least) have it in your development machine + 1) Install [Node v18](https://nodejs.org/dist/) 2) Install [Git](https://git-scm.com/downloads) 3) Install [Github Desktop App](https://desktop.github.com/) (Optional) -3) Install IDE of your choice e.g. [VS code](https://code.visualstudio.com/download) -4) Install VS code extensions: +4) Install IDE of your choice e.g. [VS code](https://code.visualstudio.com/download) +5) Install VS code extensions: - [Cucumber (Gherkin) Full Support](https://marketplace.visualstudio.com/items?itemName=alexkrechik.cucumberautocomplete) - - [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) + - [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) ### How to setup/run Cypress tests locally 1) Clone the project -2) Add `cypress.env.json` in the root folder with credentials and environment settings. +2) Rename [`cypress.env.template.json`](/cypress.env.template.json) to `cypress.env.json` in the root folder with credentials available in 1Password. 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` @@ -28,7 +29,7 @@ Install or make sure Chrome browser (at least) have it in your development machi ### Framework Structure -``` +```text (root) | |---- .github (containing github workflows) @@ -55,7 +56,7 @@ Install or make sure Chrome browser (at least) have it in your development machi |---- .gitattributes |---- .gitignore |---- reporter.js (for generating html reports) -|---- cypress.env.json (credentials & environment variables) +|---- cypress.env.template.json (credentials & environment variables - rename the file as mentioned above) |---- cypress.config.json (cypress related settings) |---- LICENSE |---- package-lock.json diff --git a/cypress.env.template.json b/cypress.env.template.json new file mode 100644 index 00000000..37561958 --- /dev/null +++ b/cypress.env.template.json @@ -0,0 +1,26 @@ +{ + "BRB": "", + "NBC": "", + "DEFAULT": "", + "TEACHER_1_EMAIL": "", + "TEACHER_1_PASSWORD": "", + "TEACHER_1_FIRST_NAME": "", + "TEACHER_1_LAST_NAME": "", + "TEACHER_2_EMAIL": "", + "TEACHER_2_PASSWORD": "", + "TEACHER_2_FIRST_NAME": "", + "TEACHER_2_LAST_NAME": "", + "STUDENT_1_EMAIL": "", + "STUDENT_1_PASSWORD": "", + "STUDENT_2_EMAIL": "", + "STUDENT_2_PASSWORD": "", + "ADMIN_1_EMAIL": "", + "ADMIN_1_PASSWORD": "", + "EXPERT_1_EMAIL": "", + "EXPERT_1_PASSWORD": "", + "STUDENT_EXTERN": "", + "STUDENT_EXTERN_PASSWORD": "", + "STUDENT_PASSWORD_CHANGE_EMAIL": "", + "STUDENT_PASSWORD_CHANGE_OLD_PWD": "", + "STUDENT_PASSWORD_CHANGE_NEW_PWD": "" +}