cypress-io /cypress-realworld-app

A payment application to demonstrate real-world usage of Cypress testing methods, patterns, and workflows.

★ 5,917⑂ 2,637👁 85⑃ 1,505● 188▤ 19
TypeScriptMITCreated 2020-01-06docs.cypress.io
TA的项目
下载:v1.0.18v1.0.18 ↓1.0.182021-08-06
+0
日增长
5,917
stars
2,637
forks
85
watchers
1,505
prs
188
issues
19
releases

README

A payment application to demonstrate real-world usage of Cypress testing methods, patterns, and workflows.



  


 💬 Note from maintainers

 This application is purely for demonstration and educational purposes. Its setup and configuration resemble typical real-world applications, but it's not a full-fledged production system. Use this app to learn, experiment, tinker, and practice application testing with Cypress.

 Happy Testing!

---

 Features

🛠 Built with [React][reactjs], [XState][xstate], [Express][express], [lowdb][lowdb], [Material-UI][material-ui] and [TypeScript][typescript]
⚡️ Zero database dependencies
🚀 Full-stack [Express][express]/[React][reactjs] application with real-world features and tests
👮‍♂️ Local Authentication
🔥 Database Seeding with End-to-end Tests
💻 CI/CD + [Cypress Cloud][cypresscloud]

 Getting Started

The Cypress Real-World App (RWA) is a full-stack Express/React application backed by a local JSON database ([lowdb]).

The app is bundled with example data (data/database.json) that contains everything you need to start using the app and run tests out-of-the-box.

 🚩 Note

 You can login to the app with any of the example app users. The default password for all users is s3cret.
 Example users can be seen by running yarn list:dev:users.

 Prerequisites

This project requires Node.js to be installed on your machine. Refer to the .node-version file for the exact version.

Yarn Classic is also required. Once you have Node.js installed, execute the following to install the npm module yarn (Classic - version 1) globally.

shell
npm install yarn@1 -g


If you have Node.js' experimental Corepack feature enabled,
then you should skip the step npm install yarn@1 -g to install Yarn Classic globally.
The RWA project is locally configured for Corepack to use Yarn Classic (version 1).

 Yarn Modern

This project is not compatible with Yarn Modern (version 2 and later).

 Installation

To clone the repo to your local system and install dependencies, execute the following commands:

shell
git clone https://github.com/cypress-io/cypress-realworld-app
cd cypress-realworld-app
yarn


 Mac users with M-series chips will need to prepend PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true.

shell
PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true yarn install


 Run the app

shell
yarn dev


 🚩 Note

 The app will run on port 3000 (frontend) and 3001 (API backend) by default. Please make sure there are no other applications or services running on both ports.
 If you want to change the default ports, you can do so by modifying PORT and VITE_BACKEND_PORT variables in .env file.
 However, make sure the modified port numbers in .env are not committed into Git since the CI environments still expect the application to run on the default ports.

 Start Cypress

shell
yarn cypress:open


 🚩 Note

 If you have changed the default ports, then you need to update Cypress configuration file (cypress.config.ts) locally.
 There are three properties that you need to update in cyp

Top issues

Discussions

Latest release

v1.0.18 v1.0.18 2021-08-06

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON