github

kentcdodds / bookshelf

  • пятница, 26 июня 2020 г. в 00:22:40
https://github.com/kentcdodds/bookshelf

JavaScript
Build a ReactJS App workshop



Build a React App - Bookshelf

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

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

Pre-Workshop Instructions/Requirements

NOTE: This repository is used for a multi-part workshop

In order for us to maximize our efforts during the workshop, please complete the following things to prepare.

  • 📺 only necessary if the workshop is remote via Zoom

  • 👋 specific to the material for this workshop

  • 3️⃣ Only needed to prepare for part 3 of this workshop

  • 4️⃣ Only needed to prepare for part 4 of this workshop

  • 👋 Setup the project (follow the setup instructions below) (~5 minutes)

  • 📺 Install and setup Zoom on the computer you will be using (~5 minutes)

  • 📺 Watch Use Zoom for KCD Workshops (~8 minutes).

  • Watch How to get the bookshelf app setup (~18 minutes). Please do NOT skip this step.

  • 👋 Watch The Beginner's Guide to React (available free on Egghead.io), or have the equivalent experience (147 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.

  • 👋 3️⃣ Go through my Advanced React Hooks Workshop, or have the equivalent basic experience of using advanced hooks. You should be experienced with useContext, useReducer, useMemo, and useCallback.

  • 👋 4️⃣ Go through my Testing React Apps Workshop, TestingJavaScript.com, or have the equivalent experience testing React components with Jest and React Testing Library.

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

System Requirements

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

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/bookshelf.git
cd bookshelf
npm run setup --silent

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

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 production deployment: bookshelf.lol.

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.

Working through the exercises

To get started, run:

node go

This will allow you to choose which exercise you want to work on. From there, open the INSTRUCTIONS.md file and follow the instructions there.

If you'd like to work on an extra credit, but you want to skip the preceding steps, you can run node go again:

node go

This will let you choose the next exercise or you can choose which part of the exercise you'd like to work on. This will update your exercise files to the correct version for you to work on that extra credit.

Workshop Outline

Snuggle up next to the 🔥 with a good 📚

👋 I'm Kent C. Dodds

Schedule

This workshop is a bit different from my other workshops. The exercises are much longer and you'll have more time to complete them. We'll also be taking breaks mid-exercise, wherever there's a need. So consider this schedule to be very loose.

Part 1

  • 😴 Logistics
  • 💪 01. Bootstrap
  • 😴 10 Minutes
  • 💪 02. Styles
  • 🌮 30 Minutes
  • 💪 03. Data Fetching
  • 😴 10 Minutes
  • ❓ Q&A

Part 2

  • 😴 Logistics
  • 💪 04. Authentication
  • 😴 10 Minutes
  • 💪 05. Routing
  • 🌮 30 Minutes
  • 💪 06. Cache Management
  • ❓ Q&A

Part 3

  • 😴 Logistics
  • 💪 07. Context
  • 😴 10 Minutes
  • 💪 08. Flexible Component
  • 🌮 30 Minutes
  • 💪 09. Performance
  • 😴 10 Minutes
  • 💪 10. Render as you fetch
  • ❓ Q&A

Part 4

  • 😴 Logistics
  • 💪 11. Unit Testing
  • 😴 10 Minutes
  • 💪 12. Testing Hooks and Components
  • 🌮 30 Minutes
  • 💪 13. Integration Testing
  • 😴 10 Minutes
  • 💪 14. E2E Testing
  • ❓ Q&A

Questions

Please do ask! Interrupt me. If you have an unrelated question, please ask on my AMA.

Zoom (for remote workshops)

  • Help us make this more human by keeping your video on if possible
  • Keep microphone muted unless speaking
  • Breakout rooms

Exercises

The exercises are in different branches. Each branch changes the INSTRUCTIONS.md file to contain instructions you need to complete the exercise.

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 Bear 🐨 will tell you when there's something specific you should do
  • Matthew the Muscle 💪 will indicate what you're working with an exercise
  • Chuck the Checkered Flag 🏁 will indicate that you're working with a final version
  • 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)
  • 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.

Workflow

  • Checkout the exercise branch
  • Read through the INSTRUCTIONS.md
  • Start exercise
  • Go through every mentioned file and follow the instructions from the emoji
  • We all come back together
  • I go through the solution and answer questions
  • Move on to the next exercise.
  • Repeat.

App Data Model

  • User

    • id: string
    • username: string

  • List Item

    • id: string
    • bookId: string
    • ownerId: string
    • rating: number (-1 is no rating, otherwise it's 1-5)
    • notes: string
    • startDate: number (Date.now())
    • finishDate: number (Date.now())

For convenience, our friendly backend engineers also return a book object on each list item which is the book it's associated to. Thanks backend folks!

/me wishes we could use GraphQL

If your "database" gets out of whack, you can purge it via:

window.__bookshelf.purgeUsers()
window.__bookshelf.purgeListItems()

  • Book

    • id: string
    • title: string
    • author: string
    • coverImageUrl: string
    • pageCount: number
    • publisher: string
    • synopsis: string

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!

Contributors

Thanks goes to these wonderful people (emoji key):


Kent C. Dodds
💻 📖 🚇 ⚠️
Vojta Holik
🎨 💻
Richard B. Kaufman-López
💻
Sekib Omazic
📖
Justin Dorfman
🔍
Nash Kabbara
📖 💻 🐛
UMAIR MOHAMMAD
💻

onemen
💻
Artem Zakharchenko
💻
Leonardo Elias
💻
Oluwaseun Oyebade
🐛
Wes Bos
🤔
Jesse Jafa
🤔
Huy Dang
🐛

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 me@kentcdodds.com