Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kentcdodds/testing-react-apps

A workshop for testing react applications
https://github.com/kentcdodds/testing-react-apps

epicreact-dev kcd-edu react testing

Last synced: 3 days ago
JSON representation

A workshop for testing react applications

Host: GitHub
URL: https://github.com/kentcdodds/testing-react-apps
Owner: kentcdodds
License: other
Created: 2019-04-04T22:36:32.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-09-30T16:54:02.000Z (3 months ago)
Last Synced: 2024-12-05T13:02:53.868Z (17 days ago)
Topics: epicreact-dev, kcd-edu, react, testing
Language: JavaScript
Homepage: https://www.epicreact.dev/modules/testing-react-apps-v1/testing-react-apps-welcome
Size: 3.3 MB
Stars: 1,074
Watchers: 13
Forks: 718
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  🧐 Testing React Applications 🚀 EpicReact.Dev

  

    Learn the essential tools and techniques to ship with confidence

  

  

    In this hands-on workshop you'll learn everything you need to test React

    components and applications with ease and get the knowledge you need to ship

    your applications with confidence.

  


  

    

  





[![Build Status][build-badge]][build]

[![All Contributors][all-contributors-badge]](#contributors)

[![GPL 3.0 License][license-badge]][license]

[![Code of Conduct][coc-badge]][coc]

[![Gitpod ready-to-code][gitpod-badge]](https://gitpod.io/#https://github.com/kentcdodds/testing-react-apps)

## Prerequisites

- Read

  [But really, what is a JavaScript Test?](https://kentcdodds.com/blog/but-really-what-is-a-javascript-test)

- Read

  [But really, what is a JavaScript Mock?](https://kentcdodds.com/blog/but-really-what-is-a-javascript-mock)

> NOTE: The EpicReact.dev videos were recorded with React version ^16.13 and all

> material in this repo has been updated to React version ^18. Differences are

> minor and any relevant differences are noted in the instructions.

## Quick start

It's recommended you run everything in the same environment you work in every

day, but if you don't want to set up the repository locally, you can get started

in one click with [Gitpod](https://gitpod.io),

[CodeSandbox](https://codesandbox.io/s/github/kentcdodds/testing-react-apps), or

by following the [video demo](https://www.youtube.com/watch?v=gCoVJm3hGk4)

instructions for [GitHub Codespaces](https://github.com/features/codespaces).

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/kentcdodds/testing-react-apps)

For a local development environment, follow the instructions below

## System Requirements

- [git][git] v2.13 or greater

- [NodeJS][node] `>=16`

- [npm][npm] v8.16.0 or greater

All of these must be available in your `PATH`. To verify things are set up

properly, you can run this:

```shell

git --version

node --version

npm --version

```

If you have trouble with any of these, learn more about the PATH environment

variable and how to fix it here for [windows][win-path] or

[mac/linux][mac-path].

## Setup

> If you want to commit and push your work as you go, you'll want to

> [fork](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo)

> first and then clone your fork rather than this repo directly.

After you've made sure to have the correct things (and versions) installed, you

should be able to just run a few commands to get set up:

```bash

git clone https://github.com/kentcdodds/testing-react-apps.git

cd testing-react-apps

node setup

```

This may take a few minutes. **It will ask you for your email.** This is

optional and just automatically adds your email to the links in the project to

make filling out some forms easier.

If you get any errors, please read through them and see if you can find out what

the problem is. If you can't work it out on your own then please [file an

issue][issue] and provide _all_ the output from the commands you ran (even if

it's a lot).

If you can't get the setup script to work, then just make sure you have the

right versions of the requirements listed above, and run the following commands:

```bash

npm install

npm run validate

```

If you are still unable to fix issues and you know how to use Docker 🐳 you can

setup the project with the following command:

```bash

docker-compose up

```

## Running the app

For this one, there's not much to the app itself. The whole reason we have the

app is just so you can see examples of the components that we'll be testing.

You'll spend most of your time in the tests.

To get the app up and running, run:

```shell

npm start

```

This should start up your browser. If you're familiar, this is a standard

[react-scripts](https://create-react-app.dev/) application.

You can also open

[the deployment of the app on Netlify](https://testing-react-apps.netlify.app/).

## Running the tests

```shell

npm test

```

This will start [Jest](https://jestjs.io/) in watch mode. Read the output and

play around with it. The tests are there to help you reach the final version,

however _sometimes_ you can accomplish the task and the tests still fail if you

implement things differently than I do in my solution, so don't look to them as

a complete authority.

### Exercises

- `src/__tests__/exercise/00.md`: Background, Exercise Instructions, Extra

  Credit

- `src/__tests__/exercise/00.js`: Exercise with Emoji helpers

- `src/__tests__/final/00.js`: Final version

- `src/__tests__/final/00.extra-0.js`: Final version of extra credit

The purpose of the exercise is **not** for you to work through all the material.

It's intended to get your brain thinking about the right questions to ask me as

_I_ walk through the material.

### Helpful Emoji 🐨 💪 🏁 💰 💯 🦉 📜 💣 👨‍💼 🚨

Each exercise has comments in it to help you get through the exercise. These fun

emoji characters are here to help you.

- **Kody the Koala** 🐨 will tell you when there's something specific you should

  do

- **Matthew the Muscle** 💪 will indicate that you're working with an exercise

- **Chuck the Checkered Flag** 🏁 will indicate that you're working with a final

  version

- **Marty the Money Bag** 💰 will give you specific tips (and sometimes code)

  along the way

- **Hannah the Hundred** 💯 will give you extra challenges you can do if you

  finish the exercises early.

- **Olivia the Owl** 🦉 will give you useful tidbits/best practice notes and a

  link for elaboration and feedback.

- **Dominic the Document** 📜 will give you links to useful documentation

- **Berry the Bomb** 💣 will be hanging around anywhere you need to blow stuff

  up (delete code)

- **Peter the Product Manager** 👨‍💼 helps us know what our users want

- **Alfred the Alert** 🚨 will occasionally show up in the test failures with

  potential explanations for why the tests are failing.

## Contributors

Thanks goes to these wonderful people

([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

  

    

      
_{Kent C. Dodds}
💻 📖 🚇 ⚠️

      
_{Gautam Pahuja}
⚠️

      
_pom421
📖

      
_{Marco Moretti}
💻

      
_{Pritam Sangani}
💻

      
_{Emmanouil Zoumpoulakis}
📖

      
_{Peter Hozák}
💻

    

    

      
_{Christian Schurr}
💻 📖

      
_{Dan Schwartz}
📖

      
_{William BEUIL}
📖

      
_{Vasilii Kovalev}
🐛

      
_{Robbert Wolfs}
🐛

      
_{Peramanathan Sathyamoorthy}
⚠️ 💻

      
_{Michaël De Boey}
💻

    

    

      
_{Bart Wijnants}
📖

      
_{Dale Seo}
💻 📖

      
_{Ryan Boone}
📖

      
_{Bob Owen}
💻 📖

      
_alberto
📖

      
_{Mario Sannum}
💻

      
_{Som Shekhar Mukherjee}
💻

    

    

      
_{Sushil Kumar}
💻

      
_{João Pina Fernandes}
📖

      
_Josh
📖

      
_{Pawan Kumar}
📖

      
_{Creeland A. Provinsal}
📖

    

  

This project follows the

[all-contributors](https://github.com/kentcdodds/all-contributors)

specification. Contributions of any kind welcome!

## Workshop Feedback

Each exercise has an Elaboration and Feedback link. Please fill that out after

the exercise and instruction.

At the end of the workshop, please go to this URL to give overall feedback.

Thank you! https://kcd.im/tra-ws-feedback

[npm]: https://www.npmjs.com/

[node]: https://nodejs.org

[git]: https://git-scm.com/

[build-badge]: https://img.shields.io/github/actions/workflow/status/kentcdodds/testing-react-apps/validate.yml?branch=main&logo=github&style=flat-square

[build]: https://github.com/kentcdodds/testing-react-apps/actions?query=workflow%3Avalidate

[license-badge]: https://img.shields.io/badge/license-GPL%203.0%20License-blue.svg?style=flat-square

[license]: https://github.com/kentcdodds/testing-react-apps/blob/main/LICENSE

[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square

[gitpod-badge]: https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod

[coc]: https://github.com/kentcdodds/testing-react-apps/blob/main/CODE_OF_CONDUCT.md

[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key

[all-contributors]: https://github.com/kentcdodds/all-contributors

[all-contributors-badge]: https://img.shields.io/github/all-contributors/kentcdodds/testing-react-apps?color=orange&style=flat-square

[win-path]: https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/

[mac-path]: http://stackoverflow.com/a/24322978/971592

[issue]: https://github.com/kentcdodds/testing-react-apps/issues/new