+
@@ -22,10 +29,8 @@
[![Build Status][build-badge]][build]
-[![All Contributors][all-contributors-badge]](#contributors)
[![GPL 3.0 License][license-badge]][license]
[![Code of Conduct][coc-badge]][coc]
-[![Gitpod ready-to-code][gitpod-badge]](https://gitpod.io/#https://github.com/kentcdodds/advanced-react-patterns)
## Prerequisites
@@ -37,28 +42,18 @@
- The more experience you have with building React abstractions, the more
helpful this workshop will be for you.
-> 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.
-
-## Quick start
-
-It's recommended you run everything in the same environment you work in every
-day, but if you don't want to set up the repository locally, you can get started
-in one click with [Gitpod](https://gitpod.io),
-[CodeSandbox](https://codesandbox.io/s/github/kentcdodds/advanced-react-patterns),
-or by following the [video demo](https://www.youtube.com/watch?v=gCoVJm3hGk4)
-instructions for [GitHub Codespaces](https://github.com/features/codespaces).
+## Pre-workshop Resources
-[](https://gitpod.io/#https://github.com/kentcdodds/advanced-react-patterns)
+Here are some resources you can read before taking the workshop to get you up to
+speed on some of the tools and concepts we'll be covering:
-For a local development environment, follow the instructions below
+- TODO: add resources
## System Requirements
-- [git][git] v2.13 or greater
-- [NodeJS][node] `14 || 16 || 18 || 19`
-- [npm][npm] v8.16.0 or greater
+- [git][git] v2.18 or greater
+- [NodeJS][node] v18 or greater
+- [npm][npm] v8 or greater
All of these must be available in your `PATH`. To verify things are set up
properly, you can run this:
@@ -75,195 +70,39 @@ variable and how to fix it here for [windows][win-path] or
## 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.
+This is a pretty large project (it's actually many apps in one) so it can take
+several minutes to get everything set up the first time. Please have a strong
+network connection before running the setup and grab a snack.
-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:
+Follow these steps to get this set up:
-```shell
-git clone https://github.com/kentcdodds/advanced-react-patterns.git
+```sh nonumber
+git clone --depth 1 https://github.com/epicweb-dev/advanced-react-patterns.git
cd advanced-react-patterns
-git checkout next2
-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:
-
-```shell
-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:
-
-```shell
-docker-compose up
-```
-
-## Running the app
-
-To get the app up and running (and really see if it worked), run:
-
-```shell
-npm start
+npm run setup
```
-Now open your browser to the address that's logged out for you and you're good
-to get started!
-
-## Running the tests
-
-The test script in the `package.json` runs the tests on the solutions (these
-should all pass). To run the tests against your own work, you simply open the
-problem page and click the "Test" tab.
-
-## TypeScript
-
-You can go through this workshop with TypeScript or JavaScript. All the files
-are TypeScript files, but if you run the script in `./scripts/remove-ts` then
-all the files will be renamed and all the TypeScript typing code will be
-removed. I do not recommend doing this, but if you want to, you can.
-
-### Exercises
-
-- `exercises/*.*/README.md`: Exercise background information
-- `exercises/*.*/*.problem.*/README.*.md`: Problem Instructions
-- `exercises/*.*/*.problem.*/*.tsx`: Exercise with Emoji helpers π You spend
- most of your time here.
-- `exercises/*.*/*.solution.*/*.tsx`: Solved version
+If you experience errors here, please open [an issue][issue] with as many
+details as you can offer.
-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
-- **Lily the Life Jacket** π¦Ί will help you with any TypeScript-specific parts
- of the exercises
-- **Marty the Money Bag** π° will give you specific tips (and sometimes code)
- along the way
-- **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
-- **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
-
-## Contributors
-
-Thanks goes to these wonderful people
-([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
-
-
-
-
-
