Skip to content
Build a ReactJS App workshop
Branch: master
Clone or download
allcontributors and kentcdodds docs: add Sparragus as a contributor (#4)
* docs: update README.md

* docs: update .all-contributorsrc


Co-authored-by: null <allcontributors[bot]@users.noreply.github.com>
Latest commit ddc59ff May 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
public NOTES May 12, 2019
scripts maybe this will work better. I hope May 17, 2019
src Fixes typo in css rull (#3) May 21, 2019
test adding more tests May 16, 2019
.all-contributorsrc docs: add Sparragus as a contributor (#4) May 21, 2019
.env init May 10, 2019
.env.development init May 10, 2019
.eslintignore ignore built file May 10, 2019
.gitignore backup .git* directories May 17, 2019
.prettierignore init May 10, 2019
.prettierrc init May 10, 2019
.travis.yml add travis May 10, 2019
CODE_OF_CONDUCT.md add missing code of conduct May 13, 2019
OUTLINE.md some small updates May 13, 2019
README.md docs: add Sparragus as a contributor (#4) May 21, 2019
appveyor.yml mabye I guess May 10, 2019
package.json tests coming along May 16, 2019
yarn.lock tests coming along May 16, 2019

README.md

Build a ReactJS App - Bookshelf

👋 hi there! My name is Kent C. Dodds and this is the source material for Build a ReactJS App!

Travis Build Status AppVeyor Build Status GPL-3.0 License All Contributors PRs Welcome Code of Conduct

Pre-Workshop Instructions/Requirements

In order for us to maximize our efforts during the workshop, please do the following:

  • Setup the project (follow the setup instructions below) (~5 minutes)
  • Install and setup Zoom on the computer you will be using (~5 minutes)
  • Watch The Beginner's Guide to React (available free on Egghead.io), or have the equivalent experience (77 minutes)
  • Watch my talk Why React Hooks (35 minutes)
  • Go through my Learn React Hooks Workshop, or have the equivalent basic experience of using hooks. You should be experienced with useState, useEffect, and useRef.
  • Go through my Advanced React Hooks, or have the equivalent basic experience of using advanced hooks. You should be experienced with useContext, useReducer, useMemo, and useCallback.

The more prepared you are for the workshop, the better it will go for you.

Workshop Outline

  • Manage forms (login and registration form)
  • Add authentication (auth-context)
  • @reach/router (setup all routes)
  • App State (List Items)
  • Code-splitting (add code-splitting the authenticated and unauthenticated pages)

System Requirements

  • git v2 or greater
  • NodeJS v8 or greater
  • yarn v1 or greater (or 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
yarn --version # or 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 should be able to work through the entire workshop in the browser. This is actually the recommended approach as it requires absolutely no setup whatsoever. Go to this codesandbox and you should be good to go.

Edit bookshelf

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:

# If you were given instructions for a specific branch to use, then use this command
# git clone --single-branch --branch <branchname> https://github.com/kentcdodds/bookshelf.git

# otherwise, this is fine:
git clone https://github.com/kentcdodds/bookshelf.git

# then do this:
cd bookshelf
npm run setup --silent

This may take a few minutes. 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

Read through OUTLINE.md

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 Bear 🐨 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.
  • 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)
  • Alfred the Alert 🚨 may occasionally show up in the test failures with potential explanations for why the tests are failing.

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 lint
npm run test:coverage
npm run build

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.

"Error: ENOSPC: System limit for number of file watchers reached" when running tests

Try increasing your system's file watchers limit:

echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

Read more about what’s happening at https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers#the-technical-details

Contributors

Thanks goes to these wonderful people (emoji key):

Kent C. Dodds
Kent C. Dodds

💻 📖 🚇 ⚠️
Vojta Holik
Vojta Holik

🎨 💻
Richard B. Kaufman-López
Richard B. Kaufman-López

💻

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

You can’t perform that action at this time.