Learn React with a laser focused, guided approach.
Branch: master
Clone or download
Latest commit 6bb5eec Feb 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
intro update exercise 4 Feb 22, 2019
public 06 done Apr 19, 2018
scripts init Apr 18, 2018
src WIP: tests busted Feb 23, 2019
test make things work Jun 27, 2018
.all-contributorsrc minor spelling/grammar/copy & paste fixes (#4) Jun 30, 2018
.gitignore init Apr 18, 2018
.npmrc update all the things Aug 14, 2018
.prettierrc init Apr 18, 2018
.travis.yml
CODE_OF_CONDUCT.md init Apr 18, 2018
CONTRIBUTING.md init Apr 18, 2018
README.md Update README.md Aug 14, 2018
RESOURCES.md add newsletter Aug 15, 2018
appveyor.yml init Apr 18, 2018
package.json update husky hooks config Feb 22, 2019
sandbox.config.json init Apr 18, 2018
yarn.lock update exercise 4 Feb 22, 2019

README.md

Learn React

👋 hi there! My name is Kent C. Dodds!

chat-badge Build Status AppVeyor Build Status Code Coverage MIT License All Contributors

PRs Welcome Code of Conduct Watch on GitHub Star on GitHub Tweet

System Requirements

  • git v2.14.1 or greater
  • NodeJS v8.9.4 or greater
  • npm v5.6.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. (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:

git clone 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 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

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 and Marty the Money Bag are here to help you. Kody 🐨 will tell you when there's something specific you should do, and Marty 💰 will give you specific tips along the way.

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

🐛 💻

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