EngageSphere

Sample project with a Node.js backend and a React frontend, running Cypress tests on GitHub Actions.

Business rules

Read the following doc to understand all the EngageSphere application's functionalities.

Pre-requirements

To run this project, you will need:

git (I've used version 2.42.1 while writing this doc)
Node.js (I've used version v20.13.1 while writing this doc)
npm (I've used version 10.5.2 while writing this doc)

Note: When installing Node.js, npm is automatically installed too.

Installing and starting the servers

Read the following doc to install and start the backend and frontend servers.

Installation of `devDependencies`

After cloning this project, to install the dev dependencies, open a terminal, go to the root of this repo, and run npm install (or npm i, for short.)

Tests

This project has frontend component tests, GUI tests, and backend API tests.

To run them all, simply run npm test (or npm t, for short.)

Frontend component tests

Run npm run test:frontend:component to run the frontend component tests.

GUI tests

Run npm run test:frontend:gui to run the GUI tests.

To use the above script, both the backend and frontend servers should be up and running.

Or, run npm run test:frontend:gui:with:servers to automatically start the servers, run the tests, and shut them down.

The GUI tests include a small suite of accessibility (a11y) tests.

API tests

Run npm run test:api to run the backend tests.

To use the above script, both the backend and frontend servers should be up and running.

Note: Although these are backend tests, the frontend server needs to be running due to the baseUrl definition at the cypress.config.js file.

Or, run npm run test:api:with:servers to automatically start the servers, run the tests, and shut them down.

Test cases

Read the following doc to get a list of test cases.

Made with ❤️ by Walmyr.

krugio/EngageSphere