Learn React
System Requirements
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. (Note: there are a few exercises in the intro
folder which you won't be able to run in codesandbox, but don't require
installing any dependencies).
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:
NOTE:
<branchname>refers to the specific branch you want to clone. If replace that with the branch you were given in the instructions ormasterif you were not given any specific instructions.
git clone --single-branch --branch <branchname> https://github.com/kentcdodds/learn-react.git
cd learn-react
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 startThis 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 testThis will start Jest in watch mode. Read the output and play around with it.
Working through it
You'll want to start in the intro/exercises directory where we start with
raw React and DOM APIs. Pull open the .html files in your browser and follow
along in the comments.
Once you get through those, then start in the src/exercises directory and
work through those.
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. - 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.
Contributors
Thanks goes to these wonderful people (emoji key):
 Kent C. Dodds |
 Nathan Hannig |
 Trevor A |
|---|
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