From 19bc816ee604dbeaec0c63906c053661f1e1c01e Mon Sep 17 00:00:00 2001 From: Dan Abramov Date: Mon, 8 Jan 2018 14:02:26 +0000 Subject: [PATCH] Document adding a router (#3709) --- template/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/template/README.md b/template/README.md index 95cf966a643..2e75de70dd5 100644 --- a/template/README.md +++ b/template/README.md @@ -34,6 +34,7 @@ You can find the most recent version of this guide [here](https://github.com/fac - [Adding Bootstrap](#adding-bootstrap) - [Using a Custom Theme](#using-a-custom-theme) - [Adding Flow](#adding-flow) +- [Adding a Router](#adding-a-router) - [Adding Custom Environment Variables](#adding-custom-environment-variables) - [Referencing Environment Variables in the HTML](#referencing-environment-variables-in-the-html) - [Adding Temporary Environment Variables In Your Shell](#adding-temporary-environment-variables-in-your-shell) @@ -804,6 +805,26 @@ In the future we plan to integrate it into Create React App even more closely. To learn more about Flow, check out [its documentation](https://flowtype.org/). +## Adding a Router + +Create React App doesn't prescribe a specific routing solution, but [React Router](https://reacttraining.com/react-router/) is the most popular one. + +To add it, run: + +```sh +npm install --save react-router react-router-dom +``` + +Alternatively you may use `yarn`: + +```sh +yarn add react-router react-router-dom +``` + +To try it, delete all the code in `src/App.js` and replace it with any of the examples on its website. The [Basic Example](https://reacttraining.com/react-router/web/example/basic) is a good place to get started. + +Note that [you may need to configure your production server to support client-side routing](#serving-apps-with-client-side-routing) before deploying your app. + ## Adding Custom Environment Variables >Note: this feature is available with `react-scripts@0.2.3` and higher.