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

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

Material for my React Fundamentals Workshop
https://github.com/kentcdodds/react-fundamentals

epicreact-dev kcd-edu react workshop

Last synced: 5 months ago
JSON representation

Material for my React Fundamentals Workshop

Awesome Lists containing this project

README

          


React Fundamentals πŸš€ EpicReact.Dev



Learn the foundational concepts necessary for building
React applications and libraries


Learn everything you need to be effective with the fundamental building
block of React applications. When you're finished, you'll be prepared to
create React components to build excellent experiences for your app's users.


Learn React from Start to Finish


[![Build Status][build-badge]][build]
[![GPL 3.0 License][license-badge]][license]
[![All Contributors][all-contributors-badge]](#contributors-)
[![Code of Conduct][coc-badge]][coc]
[![Gitpod ready-to-code][gitpod-badge]](https://gitpod.io/#https://github.com/kentcdodds/react-fundamentals)

## Prerequisites

- Read through
["JavaScript to Know for React"](https://kentcdodds.com/blog/javascript-to-know-for-react)
- Install the React DevTools
([Chrome](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
(recommended),
[Firefox](https://addons.mozilla.org/en-US/firefox/addon/react-devtools/))

> 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-fundamentals), 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-fundamentals)

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-fundamentals.git
cd react-fundamentals
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.

A few common issues during `node setup` have involved PATH variables (above
links or [here](https://github.com/kentcdodds/react-fundamentals/issues/27)),
reinstalling git, node, or npm, and clearing npm caches.

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-fundamentals.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

πŸ’» πŸ“– πŸš‡ ⚠️
Justin Dorfman
Justin Dorfman

πŸ”
Ben Ilegbodu
Ben Ilegbodu

πŸ“–
Jonathan Belcher
Jonathan Belcher

πŸ“–
Richard Hefner
Richard Hefner

πŸ’»
Zac Jones
Zac Jones

πŸ“–
Ricardo Busquet
Ricardo Busquet

πŸ“–


Arpan Chattopadhyay
Arpan Chattopadhyay

πŸ“–
Marco Moretti
Marco Moretti

πŸ’»
cindy
cindy

πŸ“–
Aaron Reisman
Aaron Reisman

πŸ“–
Jacob M-G Evans
Jacob M-G Evans

πŸ‘€
Jesse Hull
Jesse Hull

πŸ“–
Tomas Caraccia
Tomas Caraccia

πŸ“–


Vasilii Kovalev
Vasilii Kovalev

πŸ’»
Felix Geelhaar
Felix Geelhaar

πŸ“–
Apola Kipso
Apola Kipso

πŸ“–
dcgoodwin2112
dcgoodwin2112

πŸ›
Pritam Sangani
Pritam Sangani

πŸ’»
Ryan Hinerman
Ryan Hinerman

πŸ“– πŸ’»
Marco
Marco

πŸ›


Peter HozΓ‘k
Peter HozΓ‘k

πŸ’»
Emmanouil Zoumpoulakis
Emmanouil Zoumpoulakis

πŸ“–
Navneet Sahota
Navneet Sahota

πŸ“–
Rodrigo Fuentes
Rodrigo Fuentes

πŸ“–
Johnny Magrippis
Johnny Magrippis

πŸ’»
Roshan Acharya
Roshan Acharya

πŸ“–
Art Telesh
Art Telesh

πŸ“– πŸ’»


Amr A.Mohammed
Amr A.Mohammed

πŸ€”
Douglas
Douglas

πŸ“–
Gaurav
Gaurav

πŸ’»
LauraOneasca
LauraOneasca

πŸ“–
MichaΓ«l De Boey
MichaΓ«l De Boey

πŸ’»
Hannes Diercks
Hannes Diercks

⚠️
Luke
Luke

πŸ›


Toni Dezman
Toni Dezman

πŸ’»
Bobby Warner
Bobby Warner

πŸ’»
Konrad SzaΕ‚wiΕ„ski
Konrad SzaΕ‚wiΕ„ski

πŸ’»
Yaseen Kadir
Yaseen Kadir

πŸ›
Kevin Viglucci
Kevin Viglucci

πŸ“–
Iliyan Trifonov
Iliyan Trifonov

πŸ“–
Oscar Dominguez
Oscar Dominguez

πŸ“–


Aaron Casanova
Aaron Casanova

πŸ’»
Kyle Gach
Kyle Gach

πŸ“–
Anthony DikΓ©
Anthony DikΓ©

πŸ“–
Matt Schlenker
Matt Schlenker

πŸ“–
Jakub
Jakub

πŸ“–
Victor Debone
Victor Debone

πŸ“–
Mahbub Zaman
Mahbub Zaman

πŸ“–


Misaki Okajima
Misaki Okajima

πŸ“–
Mario Sannum
Mario Sannum

πŸ’»
Katherine Peterson
Katherine Peterson

πŸ“–
Alex Watt
Alex Watt

πŸ“–
Ned Redmond
Ned Redmond

⚠️
Oz Adari
Oz Adari

πŸ“–
Chiranjeev Gupta
Chiranjeev Gupta

πŸ“–


Sunnatullo Ganiev
Sunnatullo Ganiev

πŸ“–
Joey Cardosi
Joey Cardosi

πŸ“–
Luca
Luca

πŸ“–
Anjola Adeuyi
Anjola Adeuyi

πŸ“–
Sai Pavan
Sai Pavan

πŸ’»
James Murphy
James Murphy

πŸ›
Jen Gorfine
Jen Gorfine

πŸ› ️️️️♿️ πŸ’»


Ambuj sahu
Ambuj sahu

πŸ“–
Mat Chan
Mat Chan

πŸ’»
Jesse Kroon
Jesse Kroon

πŸ“–
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/rf-ws-feedback](https://kcd.im/rf-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-fundamentals/validate.yml?branch=main&logo=github&style=flat-square
[build]: https://github.com/kentcdodds/react-fundamentals/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-fundamentals/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-fundamentals/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-fundamentals?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-fundamentals/issues/new