Prerequisites
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
If you want to commit and push your work as you go, you'll want to
fork
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:
git clone https://github.com/kentcdodds/react-performance.git
cd react-performance
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 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:
npm install
npm run validate
It's recommended you run everything locally in the same environment you work in
every day, but if you're having issues getting things set up, you can also set
this up using GitHub Codespaces
(video demo) or
Codesandbox.
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. 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 Creditsrc/exercise/00.js: Exercise with Emoji helperssrc/__tests__/00.js: Testssrc/final/00.js: Final versionsrc/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 what 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):
This project follows the
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/rp-ws-feedback