setup.md

← Back to README

Setup Guide

This document provides comprehensive instructions for setting up the project environment.

---

1. Prerequisites
   

   • Install Node v18
   • Install Git
   • Install browsers (recommended Microsoft Edge) Edge Browser
   • Install IDE of your choice e.g. VS code
   • Install Github Desktop App (Optional)
   • Install VS code extensions: - Cucumber (Gherkin) Full Support - EditorConfig - Prettier
     

2. Clone the Repository Clone the project repository and navigate to the project directory:
   

      git clone <repository-url>
      cd <repository-folder>

   
   

3. Setting Up Environment Variables for the Testing User Credentials and URLs
   

   Setting Up Environment Variables for Dev Environment/Cluster:

   • Duplicate the file devTemplate.env.json and rename the duplicated file to local.env.json inside the env_variables folder.
   • Include the required development namespace URLs for BRB/DBC/NBC.
   • Test user data on development clusters are created using the school API.
   • To retrieve the API keys for all three namespaces, navigate to 1Password (1PW).
   • Contact QA team for the necessary 1Password links.

   Setting Up Environment Variables for Staging Environment/Cluster:

   • Duplicate the file stagingTemplate.env.json and rename the duplicated file to staging.env.json in the env_variables folder.
   • Include the required staging namespace URLs for BRB/DBC/NBC.
   • Test data on the staging environment are fetched from the seed data on the server.
   • Add the environment-specific credentials to staging.env.json from 1Password (1PW).
   • Ensure all instances are included, as 1Password contains different vaults for each namespace with testing credentials.
   • Contact QA team for the necessary 1Password links.

4. Installing Dependencies

   Use npm ci for a clean and consistent installation of project dependencies:
   

   npm ci

   For more details on the difference between npm ci and npm install, refer to the NPM Documentation
   

5. Running Cypress Tests For details on running Cypress tests, including options and configurations, refer to the Executing Tests Guide