From 5cc7fa41045d0f6b7b14af39418595029d2d4067 Mon Sep 17 00:00:00 2001 From: Dan Abramov Date: Sun, 20 Nov 2016 01:58:46 +0000 Subject: [PATCH] It's important after all --- packages/react-scripts/template/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/packages/react-scripts/template/README.md b/packages/react-scripts/template/README.md index 75c8c67487c..66ceb5bedc2 100644 --- a/packages/react-scripts/template/README.md +++ b/packages/react-scripts/template/README.md @@ -883,15 +883,19 @@ This will let Create React App correctly infer the root path to use in the gener >Note: this feature is available with `react-scripts@0.2.0` and higher. +**THE BELOW STEP IS IMPORTANT!**
+**If your skip it, your app will not deploy correctly.** + Open your `package.json` and add a `homepage` field: ```js "homepage": "https://myusername.github.io/my-app", ``` -**The above step is important!**
Create React App uses the `homepage` field to determine the root URL in the built HTML file. +**Have you added the `homepage` field? Then let's move on.** + Now, whenever you run `npm run build`, you will see a cheat sheet with instructions on how to deploy to GitHub Pages. To publish it at [https://myusername.github.io/my-app](https://myusername.github.io/my-app), run: @@ -918,6 +922,8 @@ Then run: npm run deploy ``` +**If you see 404 errors for JS and CSS, re-read the note at the beginning of this section saying "THE BELOW STEP IS IMPORTANT".** + You can configure a custom domain with GitHub Pages by adding a `CNAME` file to the `public/` folder. Note that GitHub Pages doesn't support routers that use the HTML5 `pushState` history API under the hood (for example, React Router using `browserHistory`). This is because when there is a fresh page load for a url like `http://user.github.io/todomvc/todos/42`, where `/todos/42` is a frontend route, the GitHub Pages server returns 404 because it knows nothing of `/todos/42`. If you want to add a router to a project hosted on GitHub Pages, here are a couple of solutions: