/cypress-example-kitchensink

This is an example app used to showcase Cypress.io testing.

Primary LanguageHTML

Kitchen Sink renovate-app badge

kitchensink

This is an example app used to showcase Cypress.io testing. The application uses every API command in Cypress for demonstration purposes. Additionally this example app is configured to run tests in various CI platforms. The tests are also heavily commented. For a full reference of our documentation, go to docs.cypress.io.

To see the kitchen sink application, visit example.cypress.io.

CI status

CI Build status basic config file full parallel config
AppVeyor AppVeyor CI appveyor.yml
Azure CI Build Status basic/azure-ci.yml
Buildkite .buildkite/pipeline.yml
Circle Circle CI basic/circle.yml circle.yml
Codeship Pro Codeship Pro CI basic/codeship-pro
GitLab GitLab CI basic/.gitlab-ci.yml .gitlab-ci.yml
Heroku CI basic/app.json
Jenkins basic/Jenkinsfile Jenkinsfile
Semaphore Semaphore CI
Shippable Shippable CI shippable.yml
Travis Travis CI basic/.travis.yml .travis.yml

You can find all CI results recorded on the Cypress Dashboard

Help + Testing

If you get stuck, here is more help:

1. Fork this repo

If you want to experiment with running this project in Continous Integration, you'll need to fork it first.

After forking this project in Github, run these commands:

## clone this repo to a local directory
git clone https://github.com/<your-username>/cypress-example-kitchensink.git

## cd into the cloned repo
cd cypress-example-kitchensink

## install the node_modules
npm install

## start the local webserver
npm start

The npm start script will spawn a webserver on port 8080 which hosts the Kitchen Sink App.

You can verify this by opening your browser and navigating to: http://localhost:8080

You should see the Kitchen Sink App up and running. We are now ready to run Cypress tests.

## launch the cypress test runner
npm run cy:open

shortcut: you can use command npm run local:open that uses start-server-and-test to start local server and open Cypress. When you close Cypress, the local server is stopped automatically. Similarly you can use npm run local:run to start the server, run Cypress tests headlessly and close the server.

2. Install & write tests in Cypress

Follow these instructions to install and write tests in Cypress.

Contributing

Check out the Contributing Guideline.

Changelog