/react-fundamentals

Material for my React Fundamentals Workshop

Primary LanguageJavaScriptOtherNOASSERTION

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 GPL 3.0 License All Contributors Code of Conduct

Prerequisites

System Requirements

  • git v2.13 or greater
  • NodeJS 12 || 14 || 15 || 16
  • npm v6 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

  • Create a fork of the Alley for of the React Fundamentals repo into your personal GitHub account.
  • 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/[username]/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), 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 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

If you are still unable to fix issues and you know how to use Docker 🐳 you can setup the project with the following command:

docker-compose up

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

  • Exercises are located in src/exercise
  • Exercise answer keys (final code) are located in src/final
  • When you first start the app you’ll be taken to a menu of all the exercises.
    • Click on either the title of the exercise or the β€œexercise” button to proceed to a specific exercise’s content.
    • Each exercise has some text to read in addition to a source code file (generally either an HTML or JS file). Exercise readmes will be visible on the left hand side of the app.
    • Changes made to exercise files (html, js) will be hot-reloaded in the exercise app and rendered on the right side of your screen.
  • Once you’ve completed an exercise, you can run npm test at the root of the repo to determine if you’ve done the exercise correctly. see previous section in this doc about tests.
    • In addition, you can double check your code against the final version in src/final and/or by using the β€œfinal” button on the exercise menu screen.
  • There’s an area in each exercise’s markdown file for you to take personal notes.
  • Create a separate PR for each exercise you complete (or, if you want to break things down further, for each extra credit as well).
    • Be sure to note which repo you're merging into as your PR base, as it may be either this repo or Kent C. Dodds' repo by default (you want to merge into your own fork).

Example locations:

  • 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

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):


Kent C. Dodds

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

Justin Dorfman

πŸ”

Ben Ilegbodu

πŸ“–

Jonathan Belcher

πŸ“–

Richard Hefner

πŸ’»

Zac Jones

πŸ“–

Ricardo Busquet

πŸ“–

Arpan Chattopadhyay

πŸ“–

Marco Moretti

πŸ’»

cindy

πŸ“–

Aaron Reisman

πŸ“–

Jacob M-G Evans

πŸ‘€

Jesse Hull

πŸ“–

Tomas Caraccia

πŸ“–

Vasilii Kovalev

πŸ’»

Felix Geelhaar

πŸ“–

Apola Kipso

πŸ“–

dcgoodwin2112

πŸ›

Pritam Sangani

πŸ’»

Ryan Hinerman

πŸ“– πŸ’»

Marco

πŸ›

Peter HozΓ‘k

πŸ’»

Emmanouil Zoumpoulakis

πŸ“–

Navneet Sahota

πŸ“–

Rodrigo Fuentes

πŸ“–

Johnny Magrippis

πŸ’»

Roshan Acharya

πŸ“–

Art Telesh

πŸ“– πŸ’»

Amr A.Mohammed

πŸ€”

Douglas

πŸ“–

Gaurav

πŸ’»

LauraOneasca

πŸ“–

MichaΓ«l De Boey

πŸ’»

Hannes Diercks

⚠️

Luke

πŸ›

Toni Dezman

πŸ’»

Bobby Warner

πŸ’»

Konrad SzaΕ‚wiΕ„ski

πŸ’»

Yaseen Kadir

πŸ›

Kevin Viglucci

πŸ“–

Iliyan Trifonov

πŸ“–

Oscar Dominguez

πŸ“–

Aaron Casanova

πŸ’»

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/rf-ws-feedback