https://github.com/wlsf82/frontend-and-backend

Sample project with basic "backend" and frontend, running Cypress tests on GitHub Actions.
https://github.com/wlsf82/frontend-and-backend

frontend github-actions react testing vercel

Last synced: 14 days ago
JSON representation

Sample project with basic "backend" and frontend, running Cypress tests on GitHub Actions.

• Host: GitHub
• URL: https://github.com/wlsf82/frontend-and-backend
• Owner: wlsf82
• Created: 2021-08-27T16:27:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-24T23:57:33.000Z (about 1 year ago)
• Last Synced: 2024-04-14T06:29:29.131Z (9 months ago)
• Topics: frontend, github-actions, react, testing, vercel
• Language: JavaScript
• Homepage: https://frontend-and-backend-jet.vercel.app
• Size: 729 KB
• Stars: 24
• Watchers: 4
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# frontend-and-backend

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

Sample project with basic "backend" and frontend, running Cypress tests on GitHub Actions.

## Pre-requirements

To run this project, you will need:

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

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

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

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

## Installing and starting the servers

Read the following [doc](./TestEnvironment.md) to install and start the backend and frontend servers.

## Installation of `devDependencies`

After cloning this project, to install the dev dependencies, run `npm install` (or `npm i` for short.)

## Tests

Run `npm run test:frontend:unit` to run the frontend unit tests.

Run `npm run test:api:with:servers` to run the API tests.

> **Note:** These scripts starts the required servers before-hand, and shuts them down when tests finish running.

Run `npm run test:frontend:with:server` to run the UI tests in headless mode.

> **Note 2:** This script starts the frontend server before-hand, and shuts it down when tests finish running.

>

> **Note 3:** When running in headless mode, if tests fail, Cypress automatically saves screenshots of the failures at `cypress/screenshots/`.

### Interactive mode

1. Run `npm run cy:open:with:servers` to open the Cypress Test Runner to run tests in interactive mode.

> **Note 4:** This script starts the required servers before-hand, and shuts them down after the runner is closed.

2. With the test runner opened, click on the test file you want to test.

___

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