Kitchen Sink

This is an example app used to showcase Cypress.io End-to-End (E2E) testing. The application demonstrates the use of most Cypress API commands. Additionally this example app is configured to run E2E tests in various CI platforms. Several workflows demonstrate the CI use of Cypress Docker images which provide convenient, pre-configured compatible environments for Cypress. The tests are also heavily commented.

To see the kitchen sink application, and to view the Cypress API commands demonstrated by the app, visit example.cypress.io.

For a full reference of our documentation, go to docs.cypress.io.

For an example payment application demonstrating real-world usage of Cypress.io End-to-End (E2E) testing, go to the cypress-io/cypress-realworld-app repository.

CI Status

The following table lists live workflows from various CI providers. These each independently test the contents of this example repository. They run and record using Cypress Cloud with their results displaying centrally under Cypress Cloud ProjectId 4b7344. Each CI provider shows its build status on its own site:

| CI Provider | Workflow | Build Status | Docker example | | :----------------------------------------------------- | :--------------------------------------------- | :---------------------------------------------------------------------- | :----------------: | | CircleCI | .circleci/config.yml | | :white_check_mark: | | cypress-io/github-action | using-action.yml | | | | GitHub Actions | single.yml | | | | GitHub Actions | parallel.yml | | |

<!-- CI provider links -->

You can find all CI results recorded on the Cypress Cloud

CI Workflow Examples

This table shows additional examples of CI workflows. With the exception of GitHub Actions workflows, these are not live examples as in the table above and they may require modification before use. The GitHub Actions workflows are live and they run without recording to Cypress Cloud.

| CI Provider | Basic Config | Full Parallel Config | Docker example | | :---------------------------------------------------- | :------------------------------------------------------- | :--------------------------------------------------- | :----------------: | | AWS Amplify | amplify.yml | | | | AWS CodeBuild | basic/buildspec.yml | buildspec.yml | | | Azure Pipelines | basic/azure-ci.yml | azure-ci.yml | | | Buddy.works | buddy.yml | | :white_check_mark: | | Buildkite | .buildkite/pipeline.yml | | | | CircleCI | basic/.circleci/config.yml | | :white_check_mark: | | GitHub Actions | chrome.yml | | | | GitHub Actions | chrome-docker.yml | | :white_check_mark: | | GitLab | basic/.gitlab-ci.yml | .gitlab-ci.yml | :white_check_mark: | | Jenkins | basic/Jenkinsfile | Jenkinsfile | :white_check_mark: | | Semaphore 2.0 | basic/.semaphore.yml | .semaphore/semaphore.yml | | | Travis CI | basic/.travis.yml | .travis.yml | |

<!-- CI provider doc links -->

The Cypress documentation page CI Provider Examples provides some more examples with extensive guides for using Cypress with some of the most popular CI providers.

Run Tests

Local testing

To run the tests from this repo on your local machine, first make sure your machine meets the Cypress System Requirements, including the installation of Node.js according to the version specified in the file .node-version.

Executing the following instructions will clone the repository, install dependencies and run Cypress:

git clone https://github.com/cypress-io/cypress-example-kitchensink.git
cd cypress-example-kitchensink
npm ci # install dependencies
npm run local:run # run Cypress headlessly

local:run is a package.json script that starts a local webserver and then uses cypress run to run Cypress headlessly. If you would like to run Cypress tests interactively, then run the following command which uses cypress open to run Cypress in headed mode. You can pick individual tests to run.

npm run local:open

As an alternative to using the `local:o