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 | Build status | basic config file | full parallel config |
|---|---|---|---|
| AWS Amplify Console | amplify.yml | ||
| AppVeyor | appveyor.yml | ||
| Azure CI | basic/azure-ci.yml | azure-ci.yml | |
| Buddy | buddy.yml | ||
| Buildkite | .buildkite/pipeline.yml | ||
| Circle |  |
basic/.circleci/config.yml | .circleci/config.yml |
| Codeship Pro | basic/codeship-pro | ||
| GitHub Actions |  |
single.yml | parallel.yml |
| GitLab |  |
basic/.gitlab-ci.yml | .gitlab-ci.yml |
| Heroku CI | basic/app.json | ||
| Jenkins | basic/Jenkinsfile | Jenkinsfile | |
| Netlify | netlify.toml | ||
| Semaphore v2 |  |
basic/.semaphore.yml | .semaphore/semaphore.yml |
| Shippable | shippable.yml | ||
| Travis |  |
basic/.travis.yml | .travis.yml |
You can find all CI results recorded on the
If you are looking for BitBucket Pipelines example, check out bitbucket.org/cypress-io/cypress-example-kitchensink.
| CI | Url |
|---|---|
| IBM Cloud CI | Cloud Foundry |
| GitLab CI | Example caching when installing using Yarn |
If you get stuck, here is more help:
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 startThe 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:openshortcut: 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.
Follow these instructions to install and write tests in Cypress.
Check out the Contributing Guideline.
- after v1.0.4 at cypress-example-kitchensink/releases
- before at CHANGELOG_OLD.md