https://github.com/epicweb-dev/get-started-with-react-router
Learn the fundamentals of the React Router library
https://github.com/epicweb-dev/get-started-with-react-router
epicreact-dev epicweb-dev kcd-edu react react-router workshop
Last synced: 4 months ago
JSON representation
Learn the fundamentals of the React Router library
- Host: GitHub
- URL: https://github.com/epicweb-dev/get-started-with-react-router
- Owner: epicweb-dev
- License: other
- Created: 2025-02-26T19:10:16.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-27T01:17:03.000Z (4 months ago)
- Last Synced: 2025-02-27T02:20:17.176Z (4 months ago)
- Topics: epicreact-dev, epicweb-dev, kcd-edu, react, react-router, workshop
- Language: TypeScript
- Homepage: https://get-started-with-react-router.epicweb.dev
- Size: 8.06 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Get Started with React Router ðŸ§
Learn the fundamentals of the React Router library
In this workshop you'll get going with React Router from the very beginning all the way to creating routes with dynamic segments, layout routes, nested routes, and linking between all of these different kinds of routes. It's a perfect start to your routing journey.
[![Build Status][build-badge]][build]
[![GPL 3.0 License][license-badge]][license]
[![Code of Conduct][coc-badge]][coc]
## Prerequisites
- Basic understanding of HTML, CSS, JavaScript, and TypeScript
- Install the [React DevTools](https://react.dev/learn/react-developer-tools)
- You should be experienced with building custom React components
## System Requirements
- [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:
```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].
## Setup
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.
> **Warning**: This repo is _very_ large. Make sure you have a good internet
> connection before you start the setup process. The instructions below use
> `--depth` to limit the amount you download, but if you have a slow connection,
> or you pay for bandwidth, you may want to find a place with a better
> connection.
Follow these steps to get this set up:
```sh nonumber
git clone --depth 1 https://github.com/epicweb-dev/get-started-with-react-router.git
cd get-started-with-react-router
npm run setup
```
If you experience errors here, please open [an issue][issue] with as many
details as you can offer.
## The Workshop App
Learn all about the workshop app on the
[Epic Web Getting Started Guide](https://www.epicweb.dev/get-started).
[](https://www.epicweb.dev/get-started)
[npm]: https://www.npmjs.com/
[node]: https://nodejs.org
[git]: https://git-scm.com/
[build-badge]: https://img.shields.io/github/actions/workflow/status/epicweb-dev/get-started-with-react-router/validate.yml?branch=main&logo=github&style=flat-square
[build]: https://github.com/epicweb-dev/get-started-with-react-router/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/epicweb-dev/get-started-with-react-router/blob/main/LICENSE
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://kentcdodds.com/conduct
[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/epicweb-dev/get-started-with-react-router/issues/new