Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kentcdodds/bookshelf

Build a ReactJS App workshop
https://github.com/kentcdodds/bookshelf

epicreact-dev kcd-edu react

Last synced: about 2 months ago
JSON representation

Build a ReactJS App workshop

Host: GitHub
URL: https://github.com/kentcdodds/bookshelf
Owner: kentcdodds
License: other
Created: 2019-05-10T05:29:39.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-03-07T08:43:50.000Z (7 months ago)
Last Synced: 2024-04-09T18:10:34.165Z (5 months ago)
Topics: epicreact-dev, kcd-edu, react
Language: JavaScript
Homepage: https://epicreact.dev/app
Size: 6.09 MB
Stars: 2,616
Watchers: 49
Forks: 1,119
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

README

Build an Epic React App 🚀 EpicReact.Dev

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.

[![Build Status][build-badge]][build]
[![All Contributors][all-contributors-badge]](#contributors)
[![GPL 3.0 License][license-badge]][license]
[![Code of Conduct][coc-badge]][coc]

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

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

## Demo

Hosted on [https://bookshelf.lol](https://bookshelf.lol)

## 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:

```
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][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](https://github.com/features/codespaces)
([video demo](https://www.youtube.com/watch?v=gCoVJm3hGk4)) or
[Codesandbox](https://codesandbox.io/s/github/kentcdodds/bookshelf).

## 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 production deployment:
[bookshelf.lol](https://bookshelf.lol).

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

## Working through the exercises

To get started, run:

```shell
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:

```shell
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:

```javascript
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](https://github.com/kentcdodds/all-contributors#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}
🐛

_{Gabriel Abud}
📖

_{Kody Clemens}
📖

_calec
📖

_{Emmanouil Zoumpoulakis}
💻

_{Christian Schurr}
💻 🐛

_{Bob Massarczyk}
📖

_{Deepak Chandani}
💻

_{Juliano Farias}
⚠️

_{Robbert Wolfs}
📖 💻

_komisz
🐛

_{Michaël De Boey}
📆 💻

_{Marco Moretti}
💻

_{Vasilii Kovalev}
💻 📖

_{Peramanathan Sathyamoorthy}
💻

_{William BEUIL}
💻

_{Andrew Li}
📖

_{Tony Khaov}
📖

_{Stijn Geens}
📖

_{Andrés Gallego}
🤔

_{Michal Juriš}
🐛

_jkmuka
🐛

_{raqib-rasheed}
🐛

_Luke-kb
📖

_{Peter Hozák}
💻

_{Chris Chuang}
💻 🐛

_{Valentin Hervieu}
📖

_{~Sami Triki}
📖

_{Ryan Boone}
📖

_{Juan Latorre}
🐛

_{Roch Goszczyński}
💻 🐛

_{Hendrik Mittrop}
💻

_payapula
📖

_{Jelte Homminga}
📖

_{Omri Dagan}
📖

_{Justin Domingue}
📖

_{Marc-Antoine Ferland}
📖

_{Mario Sannum}
💻

_jansabbe
📖

_Aswin
📖

_{Iacopo Pazzaglia}
📖

_{Luciano Ayres}
📖

_{Sadi Kaya}
📖

_{Rowin Hernández}
📖

_{Arturo Pie}
💻

_{Caleb Jasik}
📖

_{Server Khalilov}
📖

_{Angad Sethi}
📖

_Mary
📖

_{Diego Cardoso}
📖

_kmccoan
📖

_{Ehsan Tatasadi}
📖

_PM6
💻

_{benjaminmatthews}
📖

_{juliane nagao}
📖

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!

- Part 1: https://kcd.im/bra1-ws-feedback
- Part 2: https://kcd.im/bra2-ws-feedback
- Part 3: https://kcd.im/bra3-ws-feedback
- Part 4: https://kcd.im/bra4-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/bookshelf/validate.yml?branch=main&logo=github&style=flat-square
[build]: https://github.com/kentcdodds/bookshelf/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/bookshelf/blob/main/LICENSE
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/kentcdodds/bookshelf/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/bookshelf?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/bookshelf/issues/new