Skip to content
Learn React Hooks! 🎣 βš›
Branch: master
Clone or download
Latest commit 2db360f Apr 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
public add redirects Apr 15, 2019
scripts
src add some clarity Apr 17, 2019
.all-contributorsrc
.eslintignore
.gitignore
.npmrc
.prettierrc
.travis.yml init Apr 15, 2019
CODE_OF_CONDUCT.md init Apr 15, 2019
CONTRIBUTING.md
README.md add troubleshooting for file watching limits (#7) Apr 17, 2019
appveyor.yml
package-lock.json init Apr 15, 2019
package.json init Apr 15, 2019

README.md

Learn React Hooks

πŸ‘‹ hi there! My name is Kent C. Dodds and this is the source material for Learn React Hooks!

Travis Build Status AppVeyor Build Status GPL-3.0 License All Contributors PRs Welcome Code of Conduct

Pre-Workshop Instructions/Requirements

In order for us to maximize our efforts during the workshop, please do the following:

  • Setup the project (follow the setup instructions below) (~5 minutes)
  • Install and setup Zoom on the computer you will be using (~5 minutes)
  • Watch The Beginner's Guide to React (available free on Egghead.io), or have the equivalent experience (77 minutes)
  • Watch my talk Why React Hooks (35 minutes)

The more prepared you are for the workshop, the better it will go for you.

System Requirements

  • git v2.20.1 or greater
  • NodeJS v10.15.3 or greater
  • npm v6.9.0 or greater

All of these must be available in your PATH. To verify things are set up properly, you can run this:

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 or mac/linux.

Setup

You may be able to work through the entire workshop in the browser. Go to this codesandbox and you should be good to go.

If you'd rather be able to work through the workshop on your own computer, then follow the following instructions.

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:

# If you were given instructions for a specific branch to use, then use this command
# git clone --single-branch --branch <branchname> https://github.com/kentcdodds/learn-react-hooks.git

# otherwise, this is fine:
git clone https://github.com/kentcdodds/learn-react-hooks.git

# then do this:
cd learn-react-hooks
npm run setup --silent

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. You may also want to look at Troubleshooting. If you can't work it out on your own then please file an issue and provide all the output from the commands you ran (even if it's a lot).

Running the app

To get the app up and running (and really see if it worked), run:

npm start

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

You can also open the deployment of the app on Netlify.

Running the tests

npm test

This will start Jest in watch mode. Read the output and play around with it.

Working through it

This a very exercise-heavy workshop. You'll find the exercises in the src/exercises directory. I recommend running the tests and the application. When you start an exercise, pull up the exercises page in the app and the test in the src/__tests__ directory.

Your goal will be to go into each test, swap the final version for the exercise version in the import, and make the tests pass

Helpful Emoji 🐨 πŸ’° πŸ’― πŸ¦‰ πŸ“œ

Each exercise has comments in it to help you get through the exercise. Kody the Koala Bear, Marty the Money Bag, Hannah the Hundred, Olivia the Owl, and Dominic the Document are here to help you.

  • Kody 🐨 will tell you when there's something specific you should do
  • Marty πŸ’° will give you specific tips (and sometimes code) along the way
  • Hannah πŸ’― will give you extra challenges you can do if you finish the exercises early.
  • Olivia πŸ¦‰ will give you useful tidbits/best practice notes and a link for elaboration and feedback.
  • Dominic πŸ“œ will give you links to useful documentation

Troubleshooting

"npm run setup" command not working

Here's what the setup script does. If it fails, try doing each of these things individually yourself:

# verify your environment will work with the project
node ./scripts/verify

# install dependencies
npm install

# verify the project is ready to run
npm run build
npm run test:coverage

If any of those scripts fail, please try to work out what went wrong by the error message you get. If you still can't work it out, feel free to open an issue with all the output from that script. I will try to help if I can.

"Error: ENOSPC: System limit for number of file watchers reached" when running tests

Try increasing your system's file watchers limit:

echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

Read more about what’s happening at https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers#the-technical-details

Contributors

Thanks goes to these wonderful people (emoji key):

Kent C. Dodds
Kent C. Dodds

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

πŸ’» πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!

License

This material is available for private, non-commercial use under the GPL version 3. If you would like to use this material to conduct your own workshop, please contact me at kent@doddsfamily.us

You can’t perform that action at this time.