{"id":15504299,"url":"https://github.com/kentcdodds/cypress-testing-workshop","last_synced_at":"2025-04-23T00:12:04.881Z","repository":{"id":66052726,"uuid":"179586931","full_name":"kentcdodds/cypress-testing-workshop","owner":"kentcdodds","description":"A workshop for learning how to write cypress tests","archived":false,"fork":false,"pushed_at":"2021-01-25T23:13:13.000Z","size":764,"stargazers_count":66,"open_issues_count":1,"forks_count":14,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-23T00:11:58.327Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kentcdodds.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-04T22:36:08.000Z","updated_at":"2024-04-29T08:01:19.000Z","dependencies_parsed_at":"2023-05-02T23:00:56.848Z","dependency_job_id":null,"html_url":"https://github.com/kentcdodds/cypress-testing-workshop","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kentcdodds%2Fcypress-testing-workshop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kentcdodds%2Fcypress-testing-workshop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kentcdodds%2Fcypress-testing-workshop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kentcdodds%2Fcypress-testing-workshop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kentcdodds","download_url":"https://codeload.github.com/kentcdodds/cypress-testing-workshop/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250343953,"owners_count":21415041,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T09:17:05.369Z","updated_at":"2025-04-23T00:12:04.861Z","avatar_url":"https://github.com/kentcdodds.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cypress Testing Workshop\n\n[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors)\n\n👋 hi there! My name is [Kent C. Dodds](https://kentcdodds.com)! This is a\nworkshop repo to teach you about increasing your deploy confidence by using\nCypress to test your applications.\n\n[![Build Status][build-badge]][build]\n[![AppVeyor Build Status][win-build-badge]][win-build]\n[![GPL 3.0 License][license-badge]][license]\n[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors)\n[![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc]\n\n## System Requirements\n\n- [git][git] v2 or greater\n- [NodeJS][node] v8 or greater\n- [yarn][yarn] v1 or greater (or [npm][npm] v6 or greater)\n\nAll of these must be available in your `PATH`. To verify things are set up\nproperly, you can run this:\n\n```shell\ngit --version\nnode --version\nyarn --version # or npm --version\n```\n\nIf you have trouble with any of these, learn more about the PATH environment\nvariable and how to fix it here for [windows][win-path] or\n[mac/linux][mac-path].\n\n## Setup\n\nAfter you've made sure to have the correct things (and versions) installed, you\nshould be able to just run a few commands to get set up:\n\n```\ngit clone https://github.com/kentcdodds/cypress-testing-workshop.git\ncd cypress-testing-workshop\nnpm run setup --silent\n```\n\nThis may take a few minutes. **It will ask you for your email.** This is\noptional and just automatically adds your email to the links in the project to\nmake filling out some forms easier If you get any errors, please read through\nthem and see if you can find out what the problem is. You may also want to look\nat [Troubleshooting](#troubleshooting). If you can't work it out on your own\nthen please [file an issue][issue] and provide _all_ the output from the\ncommands you ran (even if it's a lot).\n\n## Running the app\n\nTo get the app up and running (and really see if it worked), run:\n\n```shell\nnpm start\n```\n\nThis should start up your browser. If you're familiar, this is a standard\n[react-scripts](https://github.com/facebook/create-react-app) application.\n\nYou can also open\n[the deployment of the app on Netlify](https://cypress-testing-workshop.netlify.com/).\n\n## Running the tests\n\n```shell\nnpm test\n```\n\nThis will start the app and Cypress. Go ahead and play around with things.\n\n**Your goal will be to go into each test in the `exercises` directory and follow\nthe instructions to test the app**\n\n## Helpful Emoji 🐨 💰 💯 🦉 📜\n\nEach exercise has comments in it to help you get through the exercise. **Kody\nthe Koala Bear**, **Marty the Money Bag**, **Hannah the Hundred**, **Olivia the\nOwl**, and **Dominic the Document** are here to help you.\n\n- **Kody** 🐨 will tell you when there's something specific you should do\n- **Marty** 💰 will give you specific tips (and sometimes code) along the way\n- **Hannah** 💯 will give you extra challenges you can do if you finish the\n  exercises early.\n- **Olivia** 🦉 will give you useful tidbits/best practice notes.\n- **Dominic** 📜 will give you links to useful documentation\n\n## Troubleshooting\n\n\u003cdetails\u003e\n\n\u003csummary\u003e\"npm run setup\" command not working\u003c/summary\u003e\n\nHere's what the setup script does. If it fails, try doing each of these things\nindividually yourself:\n\n```\n# verify your environment will work with the project\nnode ./scripts/verify\n\n# install dependencies\nnpm install\n\n# verify the project is ready to run\nnpm run lint\nnpm run test:run\n```\n\nIf any of those scripts fail, please try to work out what went wrong by the\nerror message you get. If you still can't work it out, feel free to [open an\nissue][issue] with _all_ the output from that script. I will try to help if I\ncan.\n\n\u003c/details\u003e\n\n## Contributors\n\nThanks goes to these wonderful people\n([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore --\u003e\n\u003ctable\u003e\u003ctr\u003e\u003ctd align=\"center\"\u003e\u003ca href=\"https://kentcdodds.com\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/1500684?v=4\" width=\"100px;\" alt=\"Kent C. Dodds\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eKent C. Dodds\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/kentcdodds/cypress-testing-workshop/commits?author=kentcdodds\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/kentcdodds/cypress-testing-workshop/commits?author=kentcdodds\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#infra-kentcdodds\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e \u003ca href=\"https://github.com/kentcdodds/cypress-testing-workshop/commits?author=kentcdodds\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/wgolledge\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/35961363?v=4\" width=\"100px;\" alt=\"Will Golledge\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eWill Golledge\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/kentcdodds/cypress-testing-workshop/commits?author=wgolledge\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\u003ctd align=\"center\"\u003e\u003ca href=\"https://ryota-murakami.github.io/\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/5501268?v=4\" width=\"100px;\" alt=\"Ryota Murakami\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eRyota Murakami\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/kentcdodds/cypress-testing-workshop/commits?author=ryota-murakami\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the\n[all-contributors](https://github.com/kentcdodds/all-contributors)\nspecification. Contributions of any kind welcome!\n\n## License\n\nThis material is available for private, non-commercial use under the\n[GPL version 3](http://www.gnu.org/licenses/gpl-3.0-standalone.html). If you\nwould like to use this material to conduct your own workshop, please contact me\nat kent@doddsfamily.us\n\n[npm]: https://www.npmjs.com/\n[yarn]: https://yarnpkg.com\n[node]: https://nodejs.org\n[git]: https://git-scm.com/\n[build-badge]:\n  https://img.shields.io/travis/kentcdodds/cypress-testing-workshop.svg?style=flat-square\u0026logo=travis\n[build]: https://travis-ci.org/kentcdodds/cypress-testing-workshop\n[license-badge]:\n  https://img.shields.io/badge/license-GPL%203.0%20License-blue.svg?style=flat-square\n[license]:\n  https://github.com/kentcdodds/cypress-testing-workshop/blob/master/README.md#license\n[prs-badge]:\n  https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs]: http://makeapullrequest.com\n[donate-badge]:\n  https://img.shields.io/badge/$-support-green.svg?style=flat-square\n[donate]: http://kcd.im/donate\n[coc-badge]:\n  https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square\n[coc]:\n  https://github.com/kentcdodds/cypress-testing-workshop/blob/master/CODE_OF_CONDUCT.md\n[github-watch-badge]:\n  https://img.shields.io/github/watchers/kentcdodds/cypress-testing-workshop.svg?style=social\n[github-watch]: https://github.com/kentcdodds/cypress-testing-workshop/watchers\n[github-star-badge]:\n  https://img.shields.io/github/stars/kentcdodds/cypress-testing-workshop.svg?style=social\n[github-star]: https://github.com/kentcdodds/cypress-testing-workshop/stargazers\n[twitter]:\n  https://twitter.com/intent/tweet?text=Check%20out%20cypress-testing-workshop%20by%20@kentcdodds%20https://github.com/kentcdodds/cypress-testing-workshop%20%F0%9F%91%8D\n[twitter-badge]:\n  https://img.shields.io/twitter/url/https/github.com/kentcdodds/cypress-testing-workshop.svg?style=social\n[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key\n[all-contributors]: https://github.com/kentcdodds/all-contributors\n[win-path]:\n  https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/\n[mac-path]: http://stackoverflow.com/a/24322978/971592\n[issue]: https://github.com/kentcdodds/cypress-testing-workshop/issues/new\n[win-build-badge]:\n  https://img.shields.io/appveyor/ci/kentcdodds/cypress-testing-workshop.svg?style=flat-square\u0026logo=appveyor\n[win-build]: https://ci.appveyor.com/project/kentcdodds/cypress-testing-workshop\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkentcdodds%2Fcypress-testing-workshop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkentcdodds%2Fcypress-testing-workshop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkentcdodds%2Fcypress-testing-workshop/lists"}