Skip to content

supto09/bookshelf

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

565 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Building a full React application

The React and JavaScript ecosystem is full of tools and libraries to help you build your applications. In this (huge) workshop weโ€™ll build an application from scratch using widely supported and proven tools and techniques. Weโ€™ll cover everything about building frontend React applications, from the absolute basics to the tricky parts you'll run into building real world React apps and how to create great abstractions.

Learn React from Start to Finish

Build Status All Contributors GPL 3.0 License Code of Conduct

Prerequisites

  • You'll want experience with React before going through this material. The lessons get progressively more advanced. Once you hit something you're unfamiliar with, that's your cue to go back and review the other parts of EpicReact.Dev.

NOTE: The EpicReact.dev videos were recorded with React version ^16.13 and all material in this repo has been updated to React version ^18. Differences are minor and any relevant differences are noted in the instructions.

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.

Demo

Hosted on https://bookshelf.lol

Setup

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 https://github.com/kentcdodds/bookshelf.git
cd bookshelf
node setup

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

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.

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 ๐Ÿจ 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.

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

Troubleshooting

Running "node go" does not list any branches

This means there was something wrong when you ran the setup.

If you made your own fork of bookshelf through GitHub, you may have only got the main branch -- that's the default option

Add a new upstream remote

git remote add upstream https://github.com/kentcdodds/bookshelf.git

You might get an error: remote upstream already exists. -- no problem!

Track all the branches from that original repository

git push origin --tags "refs/remotes/upstream/*:refs/heads/*"

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

๐Ÿ’ป
Sekib Omazic
Sekib Omazic

๐Ÿ“–
Justin Dorfman
Justin Dorfman

๐Ÿ”
Nash Kabbara
Nash Kabbara

๐Ÿ“– ๐Ÿ’ป ๐Ÿ›
UMAIR MOHAMMAD
UMAIR MOHAMMAD

๐Ÿ’ป
onemen
onemen

๐Ÿ’ป
Artem Zakharchenko
Artem Zakharchenko

๐Ÿ’ป
Leonardo Elias
Leonardo Elias

๐Ÿ’ป
Oluwaseun Oyebade
Oluwaseun Oyebade

๐Ÿ›
Wes Bos
Wes Bos

๐Ÿค”
Jesse Jafa
Jesse Jafa

๐Ÿค”
Huy Dang
Huy Dang

๐Ÿ›
Gabriel Abud
Gabriel Abud

๐Ÿ“–
Kody Clemens
Kody Clemens

๐Ÿ“–
calec
calec

๐Ÿ“–
Emmanouil Zoumpoulakis
Emmanouil Zoumpoulakis

๐Ÿ’ป
Christian Schurr
Christian Schurr

๐Ÿ’ป ๐Ÿ›
Bob Massarczyk
Bob Massarczyk

๐Ÿ“–
Deepak Chandani
Deepak Chandani

๐Ÿ’ป
Juliano Farias
Juliano Farias

โš ๏ธ
Robbert Wolfs
Robbert Wolfs

๐Ÿ“– ๐Ÿ’ป
komisz
komisz

๐Ÿ›
Michaรซl De Boey
Michaรซl De Boey

๐Ÿ“† ๐Ÿ’ป
Marco Moretti
Marco Moretti

๐Ÿ’ป
Vasilii Kovalev
Vasilii Kovalev

๐Ÿ’ป ๐Ÿ“–
Peramanathan Sathyamoorthy
Peramanathan Sathyamoorthy

๐Ÿ’ป
William BEUIL
William BEUIL

๐Ÿ’ป
Andrew Li
Andrew Li

๐Ÿ“–
Tony Khaov
Tony Khaov

๐Ÿ“–
Stijn Geens
Stijn Geens

๐Ÿ“–
Andrรฉs Gallego
Andrรฉs Gallego

๐Ÿค”
Michal Juriลก
Michal Juriลก

๐Ÿ›
jkmuka
jkmuka

๐Ÿ›
raqib-rasheed
raqib-rasheed

๐Ÿ›
Luke-kb
Luke-kb

๐Ÿ“–
Peter Hozรกk
Peter Hozรกk

๐Ÿ’ป
Chris Chuang
Chris Chuang

๐Ÿ’ป ๐Ÿ›
Valentin Hervieu
Valentin Hervieu

๐Ÿ“–
~Sami Triki
~Sami Triki

๐Ÿ“–
Ryan Boone
Ryan Boone

๐Ÿ“–
Juan Latorre
Juan Latorre

๐Ÿ›
Roch Goszczyล„ski
Roch Goszczyล„ski

๐Ÿ’ป ๐Ÿ›
Hendrik Mittrop
Hendrik Mittrop

๐Ÿ’ป
payapula
payapula

๐Ÿ“–
Jelte Homminga
Jelte Homminga

๐Ÿ“–
Omri Dagan
Omri Dagan

๐Ÿ“–
Justin Domingue
Justin Domingue

๐Ÿ“–
Marc-Antoine Ferland
Marc-Antoine Ferland

๐Ÿ“–
Mario Sannum
Mario Sannum

๐Ÿ’ป
jansabbe
jansabbe

๐Ÿ“–
Aswin
Aswin

๐Ÿ“–
Iacopo Pazzaglia
Iacopo Pazzaglia

๐Ÿ“–
Luciano Ayres
Luciano Ayres

๐Ÿ“–
Sadi Kaya
Sadi Kaya

๐Ÿ“–
Rowin Hernรกndez
Rowin Hernรกndez

๐Ÿ“–
Arturo Pie
Arturo Pie

๐Ÿ’ป
Caleb Jasik
Caleb Jasik

๐Ÿ“–
Server Khalilov
Server Khalilov

๐Ÿ“–
Angad Sethi
Angad Sethi

๐Ÿ“–
Mary
Mary

๐Ÿ“–
Diego Cardoso
Diego Cardoso

๐Ÿ“–
kmccoan
kmccoan

๐Ÿ“–
Ehsan Tatasadi
Ehsan Tatasadi

๐Ÿ“–
PM6
PM6

๐Ÿ’ป
benjaminmatthews
benjaminmatthews

๐Ÿ“–
juliane nagao
juliane nagao

๐Ÿ“–

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!

About

Build a ReactJS App workshop

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 98.4%
  • HTML 1.1%
  • Other 0.5%