https://github.com/wlsf82/engagesphere

The EngageSphere web application is aimed at our salespeople so they can access our customer's contact information.
https://github.com/wlsf82/engagesphere

component-testing cypress docker dockerfile elements-of-test-design express heroku javascript js nodejs react react-components software-design talking-about-testing test-automation test-design test-design-masterclass test-design-masterclass-tat testing vercel

Last synced: 30 days ago
JSON representation

The EngageSphere web application is aimed at our salespeople so they can access our customer's contact information.

• Host: GitHub
• URL: https://github.com/wlsf82/engagesphere
• Owner: wlsf82
• License: mit
• Created: 2024-02-20T23:03:14.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-10-23T22:59:53.000Z (3 months ago)
• Last Synced: 2024-10-24T11:52:29.208Z (3 months ago)
• Topics: component-testing, cypress, docker, dockerfile, elements-of-test-design, express, heroku, javascript, js, nodejs, react, react-components, software-design, talking-about-testing, test-automation, test-design, test-design-masterclass, test-design-masterclass-tat, testing, vercel
• Language: JavaScript
• Homepage: https://engage-sphere.vercel.app
• Size: 3.08 MB
• Stars: 7
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# EngageSphere

[![CI](https://github.com/wlsf82/EngageSphere/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/wlsf82/EngageSphere/actions/workflows/ci-cd.yml)

[![EngageSphere](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/yebzus/main&style=flat&logo=cypress)](https://cloud.cypress.io/projects/yebzus/runs)

Sample project with a [Node.js](https://nodejs.org/) backend and a [React](https://react.dev/) frontend, running [Cypress](https://www.cypress.io/) tests on [GitHub Actions](https://github.com/features/actions).

## Business rules

Read the following [doc](./docs/Requirements.md) to understand all the EngageSphere application's functionalities.

## Pre-requirements

To run this project, you will need:

- [git](https://git-scm.com/downloads) (I've used version `2.42.1` while writing this doc)

- [Node.js](https://nodejs.org/en/) (I've used version `v22.11.0` while writing this doc)

- npm (I've used version `10.9.0` while writing this doc)

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

## Installing and starting the servers

Read the following [doc](./docs/TestEnvironment.md) 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, the backend server should be up and running.

Or, run `npm run test:api:with:server` to automatically start the backend server, run the tests, and shut it down.

### Test cases

Read the following [doc](./docs/TestCases.md) to get a list of test cases.

___

Made with ❤️ by [Walmyr](https://walmyr.dev).