https://github.com/kentcdodds/react-suspense
React Suspense workshop
https://github.com/kentcdodds/react-suspense
Last synced: 6 months ago
JSON representation
React Suspense workshop
- Host: GitHub
- URL: https://github.com/kentcdodds/react-suspense
- Owner: kentcdodds
- License: other
- Created: 2024-02-15T22:20:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T16:54:21.000Z (over 1 year ago)
- Last Synced: 2024-12-10T10:02:28.761Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://www.epicreact.dev/modules/react-suspense-v1/react-suspense-welcome
- Size: 2.36 MB
- Stars: 30
- Watchers: 2
- Forks: 22
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-list - react-suspense
README
🔀 React Suspense 🚀 EpicReact.Dev
Simplify your Async UI and improve your User Experience
Learn how Suspense works under the hood, preparing you for the future of asynchronous state management.
[![Build Status][build-badge]][build]
[![All Contributors][all-contributors-badge]](#contributors)
[![GPL 3.0 License][license-badge]][license]
[![Code of Conduct][coc-badge]][coc]
[![Gitpod ready-to-code][gitpod-badge]](https://gitpod.io/#https://github.com/kentcdodds/react-suspense)
## ⚠️ Warning ⚠️
This workshop material deals with **EXPERIMENTAL** features in React. Please do
not copy/paste any of the code you find here into a production application and
expect it to work. The features have been released in the latest version of
React 18 and there are some slight changes. However the concepts and most APIs
taught in this workshop are still applicable (any changes are noted in the
material).
## NOTICE:
This workshop deals a lot with error boundaries and it's important to note that
create-react-app has a special and helpful "Error Overlay" component that will
sometimes be displayed when an error occurs (whether your app implements error
boundaries or not). For you to see the error handling within the app, you'll
need to close that overlay by clicking the "x" in the upper-right.
## Prerequisites
- 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/))
- Watch Dan Abramov's talk
[Beyond React 16 | JSConf Iceland 2018](https://www.youtube.com/watch?v=nLF0n9SACd4)
(33 minutes)
- Experience with React and all hooks
## 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-suspense), or by
following the [video demo](https://www.youtube.com/watch?v=gCoVJm3hGk4)
instructions for [GitHub Codespaces](https://github.com/features/codespaces).
[](https://gitpod.io/#https://github.com/kentcdodds/react-suspense)
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-suspense.git
cd react-suspense
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][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-suspense.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
💻 📖 🚇 ⚠️
Filipp Riabchun
💻
lauchness
💻
Pritam Sangani
💻
Emmanouil Zoumpoulakis
📖
Peter Hozák
💻
Jerome Carty
💻
Anthony Ng
📖
Vasilii Kovalev
🐛 📖
Michaël De Boey
💻
Daniel Söderling
📖
Bobby Warner
💻
Jesús Rodríguez
📖
Cesar Carbajo
💻
Alex Bussey
📖
Tymur Mudzhyri
🐛 💻
Bill Fienberg
📖
Martin Carel
📖
Gaëtan Kueny
🐛
Pavel Fomchenkov
🐛
Andriy Bas
💻
Pavlos Vinieratos
📖
Mario Sannum
💻
Luciano Ayres
📖
Caleb Jasik
📖
Philipp Vujic
💻
Emre
📖
Pawan Kumar
📖
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/rs-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-suspense/validate.yml?branch=main&logo=github&style=flat-square
[build]: https://github.com/kentcdodds/react-suspense/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-suspense/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-suspense/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-suspense?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-suspense/issues/new