- [git][git] v2.13 or greater
- [NodeJS][node]
12 || 14 || 15 || 16
- [npm][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][win-path] or [mac/linux][mac-path].
If you want to commit and push your work as you go, you'll want to fork 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:
git clone repo_URL
cd bookshelf
node setup
This may take a few minutes.
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.
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.
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.
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.
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.
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 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.
- 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.
- 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.
-
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