Skip to content

Commit

Permalink
Always build before deploying to gh-pages (#959)
Browse files Browse the repository at this point in the history
* Always build before deploying to gh-pages

* Add line to gh-pages deploy docs about CNAME file

* Remove spaces in npm run command for Windows

* Grammar nit

* Minor tweaks
  • Loading branch information
dsernst authored and gaearon committed Oct 28, 2016
1 parent a0efbeb commit fcda24e
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions packages/react-scripts/template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -887,7 +887,7 @@ Open your `package.json` and add a `homepage` field:
**The above step is important!**<br>
Create React App uses the `homepage` field to determine the root URL in the built HTML file.
Now, whenever you run `npm run build`, you will see a cheat sheet with instructions on how to deploy to GitHub pages.
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:
Expand All @@ -901,16 +901,20 @@ Add the following script in your `package.json`:
// ...
"scripts": {
// ...
"deploy": "gh-pages -d build"
"deploy": "npm run build&&gh-pages -d build"
}
```
(Note: the lack of whitespace is intentional.)
Then run:
```sh
npm run deploy
```
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:
* You could switch from using HTML5 history API to routing with hashes. If you use React Router, you can switch to `hashHistory` for this effect, but the URL will be longer and more verbose (for example, `http://user.github.io/todomvc/#/todos/42?_k=yknaj`). [Read more](https://github.com/reactjs/react-router/blob/master/docs/guides/Histories.md#histories) about different history implementations in React Router.
* Alternatively, you can use a trick to teach GitHub Pages to handle 404 by redirecting to your `index.html` page with a special redirect parameter. You would need to add a `404.html` file with the redirection code to the `build` folder before deploying your project, and you’ll need to add code handling the redirect parameter to `index.html`. You can find a detailed explanation of this technique [in this guide](https://github.com/rafrex/spa-github-pages).
Expand Down

0 comments on commit fcda24e

Please sign in to comment.