Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kentcdodds/react-hooks

Learn React Hooks! 🎣 βš›
https://github.com/kentcdodds/react-hooks

epicreact-dev kcd-edu react

Last synced: 10 days ago
JSON representation

Learn React Hooks! 🎣 βš›

Awesome Lists containing this project

README

        


🎣 React Hooks πŸš€ EpicReact.Dev



Learn the ins and outs of React Hooks.


I will take you on a deep dive into
React Hooks, and show you what you need to know to start using them in your
applications right away.


Learn React from Start to Finish


[![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/react-hooks)

## Prerequisites

- Watch my talk
[Why React Hooks](https://www.youtube.com/watch?v=zWsZcBiwgVE&list=PLV5CVI1eNcJgNqzNwcs4UKrlJdhfDjshf)
(35 minutes)

> 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/react-hooks), 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/react-hooks)

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:

```shell
git clone https://github.com/kentcdodds/react-hooks.git
cd react-hooks
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:

```shell
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:

```shell
docker-compose up
```

## Running the app

To get the app up and running (and really see if it worked), 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://react-hooks.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/exercise/00.md`: Background, Exercise Instructions, Extra Credit
- `src/exercise/00.js`: Exercise with Emoji helpers
- `src/__tests__/00.js`: Tests
- `src/final/00.js`: Final version
- `src/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
- **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.
- **Nancy the Notepad** πŸ“ will encourage you to take notes on what you're
learning
- **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)
- **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
- **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
Kent C. Dodds

πŸ’» πŸ“– πŸš‡ ⚠️
Tyler Nieman
Tyler Nieman

πŸ’» πŸ“–
Mike Plis
Mike Plis

πŸ’» ⚠️
Justin Dorfman
Justin Dorfman

πŸ”
Carlos PΓ©rez GutiΓ©rrez
Carlos PΓ©rez GutiΓ©rrez

πŸ’»
Charlie Stras
Charlie Stras

πŸ“– πŸ’»
Lide
Lide

πŸ“–


Marco Moretti
Marco Moretti

πŸ’»
Watchmaker
Watchmaker

πŸ›
Daniel Chapman
Daniel Chapman

πŸ’»
flofehrenbacher
flofehrenbacher

πŸ“–
Pritam Sangani
Pritam Sangani

πŸ’»
Emmanouil Zoumpoulakis
Emmanouil Zoumpoulakis

πŸ“–
Peter HozΓ‘k
Peter HozΓ‘k

πŸ’» πŸ“–


Timo
Timo

πŸ“–
Thacher Hussain
Thacher Hussain

πŸ“–
Johnny Magrippis
Johnny Magrippis

πŸ’»
Apola Kipso
Apola Kipso

πŸ’»
Markus Lasermann
Markus Lasermann

⚠️
Stijn Geens
Stijn Geens

πŸ“–
Adeildo Amorim
Adeildo Amorim

πŸ“–


Greg Sheppard
Greg Sheppard

πŸ“–
Rafael D. Hernandez
Rafael D. Hernandez

πŸ’»
Dallas Carraher
Dallas Carraher

πŸ“–
Roni Castro
Roni Castro

⚠️
Brennan
Brennan

πŸ“–
Dale Seo
Dale Seo

⚠️
MichaΓ«l De Boey
MichaΓ«l De Boey

πŸ’»


Bobby Warner
Bobby Warner

πŸ’»
Doug Lance
Doug Lance

πŸ“–
Yury Nekhaevskiy
Yury Nekhaevskiy

πŸ“–
MΓ₯ns Nilsson
MΓ₯ns Nilsson

πŸ“–
Clark Winters
Clark Winters

πŸ›
Omar Houmz
Omar Houmz

πŸ’»
Giovanni Ravalico
Giovanni Ravalico

πŸ’» πŸ€”


Juan Enrique Segebre Zaghmout
Juan Enrique Segebre Zaghmout

πŸ’»
John Alexander Ferguson
John Alexander Ferguson

⚠️
Trent Schneweis
Trent Schneweis

πŸ’»
Dan Loewenherz
Dan Loewenherz

πŸ’»
Shivaprabhu
Shivaprabhu

πŸ“–
Jacob Paris
Jacob Paris

πŸ“–
Eike MΓΌcksch
Eike MΓΌcksch

⚠️


Pavlos Vinieratos
Pavlos Vinieratos

πŸ“–
Misaki Okajima
Misaki Okajima

πŸ’» πŸ“–
Mario Sannum
Mario Sannum

πŸ’»
jaquinocode
jaquinocode

πŸ›
Kobe Ruado
Kobe Ruado

πŸ’»
Prasanth Louis
Prasanth Louis

πŸ“–
Sheryl Hohman
Sheryl Hohman

πŸ’»


Victoria Vasys
Victoria Vasys

πŸ“–
Elan
Elan

πŸ“–
Mohammad Bagher Ehtemam
Mohammad Bagher Ehtemam

πŸ“–
Simon Legg
Simon Legg

πŸ“–
Philipp Vujic
Philipp Vujic

⚠️
Roman Cherepanov
Roman Cherepanov

πŸ“–
Ambuj sahu
Ambuj sahu

πŸ“–


Pietro Nadalini
Pietro Nadalini

πŸ“– πŸ’»
Stanley Ulili
Stanley Ulili

πŸ›
Jamie Harnum
Jamie Harnum

πŸ’»
Pano Papadatos
Pano Papadatos

πŸ“–
Atlas Sproson
Atlas Sproson

πŸ“–
juliane nagao
juliane nagao

πŸ“–
Creeland A. Provinsal
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/rh-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/react-hooks/validate.yml?branch=main&logo=github&style=flat-square
[build]: https://github.com/kentcdodds/react-hooks/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/react-hooks/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/react-hooks/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/react-hooks?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/react-hooks/issues/new