This repository contains automated end-to-end (E2E) tests for the Judge.me platform using Cypress. The repository also includes test cases written in both Gherkin syntax and a PDF sheet for easy readability and collaboration.
Before running the Cypress tests, ensure that your environment meets the following requirements:
- Node.js (version 14 or above)
- npm or yarn
- A supported browser (e.g., Chrome, Edge)
-
Clone the repository:
git clone https://github.com/uncleejay/judgemetest.git cd judgemetest -
Installation
npm install
All test cases are available in a PDF document located in the docs folder. This document provides a detailed breakdown of each test scenario.
Test cases written in Gherkin syntax are located in the docs folder. These scenarios are written in Cucumber for non-techies.
Custom npm scripts are defined in the package.json file for running specific types of tests. Use the following commands:
-
Run all test
npm run judgme
-
Run all test in headed mode
npm run judgeme-headed
N/B: This test has accessibility test and lighthouse performance audit integrated in the test. Meaning it will run automatically with other test cases.
The project is integrated with GitHub Actions for Continuous Integration (CI). The test suite automatically runs on every pull request and merge to the main branch. To trigger a test manually:
- Push your changes to the branch.
- Open a pull request to the main branch.
- GitHub Actions will automatically execute the test suite.
The majority of the tests will pass and some may fail because of accessibility issues and lighthouse performance audits. You can comment the test cases for accessibility and performance issue out to see all test pass in CI. But this is there to show how it works.