|
| 1 | +<div align="center"> |
| 2 | + <h1><a href="https://www.epicweb.dev/workshops">End-to-end React Application Testing with Playwright</a></h1> |
| 3 | + <strong> |
| 4 | + </strong> |
| 5 | +</div> |
| 6 | + |
| 7 | +<hr /> |
| 8 | + |
| 9 | +<div align="center"> |
| 10 | + <a |
| 11 | + alt="Epic Web logo with the words Deployed Version" |
| 12 | + href="https://e2e-react-application-testing-with-playwright.epicweb.dev/" |
| 13 | + > |
| 14 | + <img |
| 15 | + width="300px" |
| 16 | + src="https://github-production-user-asset-6210df.s3.amazonaws.com/1500684/254000390-447a3559-e7b9-4918-947a-1b326d239771.png" |
| 17 | + /> |
| 18 | + </a> |
| 19 | +</div> |
| 20 | + |
| 21 | +<hr /> |
| 22 | + |
| 23 | +<!-- prettier-ignore-start --> |
| 24 | +[![Build Status][build-badge]][build] |
| 25 | +[![GPL 3.0 License][license-badge]][license] |
| 26 | +[![Code of Conduct][coc-badge]][coc] |
| 27 | +<!-- prettier-ignore-end --> |
| 28 | + |
| 29 | +## Prerequisites |
| 30 | + |
| 31 | +> TODO |
| 32 | +
|
| 33 | +## Pre-workshop Resources |
| 34 | + |
| 35 | +> TODO |
| 36 | +
|
| 37 | +## System Requirements |
| 38 | + |
| 39 | +- [git][git] v2.18 or greater |
| 40 | +- **[NodeJS][node] v23.11.0 or greater** |
| 41 | +- [npm][npm] v8 or greater |
| 42 | + |
| 43 | +All of these must be available in your `PATH`. To verify things are set up |
| 44 | +properly, you can run this: |
| 45 | + |
| 46 | +```shell |
| 47 | +git --version |
| 48 | +node --version |
| 49 | +npm --version |
| 50 | +``` |
| 51 | + |
| 52 | +If you have trouble with any of these, learn more about the PATH environment |
| 53 | +variable and how to fix it here for [windows][win-path] or |
| 54 | +[mac/linux][mac-path]. |
| 55 | + |
| 56 | +## Setup |
| 57 | + |
| 58 | +This is a pretty large project (it's actually many apps in one) so it can take |
| 59 | +several minutes to get everything set up the first time. Please have a strong |
| 60 | +network connection before running the setup and grab a snack. |
| 61 | + |
| 62 | +> **Warning**: This repo is _very_ large. Make sure you have a good internet |
| 63 | +> connection before you start the setup process. The instructions below use |
| 64 | +> `--depth` to limit the amount you download, but if you have a slow connection, |
| 65 | +> or you pay for bandwidth, you may want to find a place with a better |
| 66 | +> connection. |
| 67 | +
|
| 68 | +Follow these steps to get this set up: |
| 69 | + |
| 70 | +```sh nonumber |
| 71 | +git clone --depth 1 https://github.com/epicweb-dev/e2e-react-application-testing-with-playwright.git |
| 72 | +cd e2e-react-application-testing-with-playwright |
| 73 | +npm run setup |
| 74 | +``` |
| 75 | + |
| 76 | +If you experience errors here, please open [an issue][issue] with as many |
| 77 | +details as you can offer. |
| 78 | + |
| 79 | +## The Workshop App |
| 80 | + |
| 81 | +Learn all about the workshop app on the |
| 82 | +[Epic Web Getting Started Guide](https://www.epicweb.dev/get-started). |
| 83 | + |
| 84 | +[](https://www.epicweb.dev/get-started) |
| 85 | + |
| 86 | +<!-- prettier-ignore-start --> |
| 87 | +[npm]: https://www.npmjs.com/ |
| 88 | +[node]: https://nodejs.org |
| 89 | +[git]: https://git-scm.com/ |
| 90 | +[build-badge]: https://img.shields.io/github/actions/workflow/status/epicweb-dev/e2e-react-application-testing-with-playwright/validate.yml?branch=main&logo=github&style=flat-square |
| 91 | +[build]: https://github.com/epicweb-dev/e2e-react-application-testing-with-playwright/actions?query=workflow%3Avalidate |
| 92 | +[license-badge]: https://img.shields.io/badge/license-GPL%203.0%20License-blue.svg?style=flat-square |
| 93 | +[license]: https://github.com/epicweb-dev/e2e-react-application-testing-with-playwright/blob/main/LICENSE |
| 94 | +[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square |
| 95 | +[coc]: https://kentcdodds.com/conduct |
| 96 | +[win-path]: https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/ |
| 97 | +[mac-path]: http://stackoverflow.com/a/24322978/971592 |
| 98 | +[issue]: https://github.com/epicweb-dev/e2e-react-application-testing-with-playwright/issues/new |
| 99 | +<!-- prettier-ignore-end --> |
0 commit comments