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 |
|---|---|---|---|
| AppVeyor | appveyor.yml | ||
| Azure CI | basic/azure-ci.yml | ||
| Buildkite |  |
.buildkite/pipeline.yml | |
| Circle |  |
basic/circle.yml | circle.yml |
| Codeship Pro | |
basic/codeship-pro | |
| GitLab |  |
basic/.gitlab-ci.yml | .gitlab-ci.yml |
| Heroku CI | basic/app.json | ||
| Jenkins | basic/Jenkinsfile | Jenkinsfile | |
| Semaphore |  |
||
| Shippable | shippable.yml | ||
| Travis |  |
basic/.travis.yml | .travis.yml |
You can find all CI results recorded on the
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.
- update image placeholder links to https
- update cy.trigger example
- add cy.request example with query params
- update deps
- update image placeholder links to https
- update cy.trigger example
- add cy.request example with query params
- update deps
- updated dependencies
- add Cypress.Screenshot.defaults test
- improvements to build and deploy process
- bump to node 8
- updated README to link to correct examples folder
- added assertion to prevUntil test
- split example_spec into seperate files
- convert all JS from ES5 -> ES6
- update all code content to match actual specs
- move all Cypress API examples into 1 page
- have nav be active when visiting page
- add GitHub link to repo in main nav
- add link to docs from every header
- general grammar and link fixes
- add platform check to cy.exec() example
- fix typo
- eslint tests and js script
- updated .prev html to match test
- added contributing doc
- updated for cypress 0.20.0
- added new cy commands
- update support files for new scaffolding
- new traversal commands
- fix flaky location calls
- remove .only
- added stubs, spies, clocks example, fix cy.readFile
- missing var
- bump up default config values
- prevent file server caching
- renamed Fixtures section to Files
- added examples for writeFile
- added example for readFile
- added examples for using modifier keys on cy.type
- fixed some formatting
- rename commandTimeout -> defaultCommandTimeout
- remove spacejam visit, use https
- added cy.screenshot example
- added cy.exec() command examples
- fix for clearing 3rd party cookies after visit
- removed methods on Cypress.Cookies
- removed selenium references
- added examples of new cypress cookie commands
- removed relative cy.visit which causes errors on new projects
- updated node version to 5.10.0
- renamed visitTimeout option to pageLoadTimeout
- updated links to be https
- added cy.reload(true) example
- initial release