-
-
Notifications
You must be signed in to change notification settings - Fork 26.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
readme: Advanced Configuration #1515
Changes from 5 commits
6de9887
8e8e484
df055ad
4efa557
ecfd2f9
0bbab3d
e194f52
9292a4e
598e29a
4faceb6
4701209
595095f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -63,6 +63,7 @@ You can find the most recent version of this guide [here](https://github.com/fac | |
- [Now](#now) | ||
- [S3 and CloudFront](#s3-and-cloudfront) | ||
- [Surge](#surge) | ||
- [Advanced Configuration](#advanced-configuration) | ||
- [Troubleshooting](#troubleshooting) | ||
- [`npm start` doesn’t detect changes](#npm-start-doesnt-detect-changes) | ||
- [`npm test` hangs on macOS Sierra](#npm-test-hangs-on-macos-sierra) | ||
|
@@ -1289,6 +1290,19 @@ Install the Surge CLI if you haven't already by running `npm install -g surge`. | |
|
||
Note that in order to support routers that use HTML5 `pushState` API, you may want to rename the `index.html` in your build folder to `200.html` before deploying to Surge. This [ensures that every URL falls back to that file](https://surge.sh/help/adding-a-200-page-for-client-side-routing). | ||
|
||
## Advanced Configuration | ||
|
||
You can adjust various development and production settings via environment variables. | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Worth linking to the section about |
||
Variable | Development | Production | Usage | ||
:--- | :---: | :---: | :--- | ||
BROWSER | :white_check_mark: | :x: | By default, Create React App will open the default system browser, favoring Chrome on macOS. To override this behavior, the browser may be specified or set to `none` to disable this behavior. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should at least link to all valid values here. Not sure where the list is, but this is a start. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, maybe more succinctly:
? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for catching my unnecessary wording, @existentialism. |
||
HOST | :white_check_mark: | :x: | By default, the development web server binds to `localhost`. You may use this variable to specify a different host. | ||
PORT | :white_check_mark: | :x: | By default, the development web server will attempt to listen on port 3000 or prompt you to attempt the next available port. You may use this variable to specify a different port. | ||
HTTPS | :white_check_mark: | :x: | When set to `true`, Create React App will run the development server in `https` mode. | ||
PUBLIC_URL | :x: | :white_check_mark: | Create React App assumes your application is hosted at the serving web server's root or a subpath as specified in `package.json` (`homepage`). Normally, Create React App ignores the hostname. You may use this variable to force assets to be referenced verbatim to the url you provide (hostname included). This may be particularly useful when using a CDN to host your application. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This should link to the relevant section in this doc. |
||
CI | :large_orange_diamond: | :white_check_mark: | When set to `true`, Create React App treats warnings as failures in the build. It also makes the test runner non-watching. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Worth mentioning most CIs already specify it by default. |
||
|
||
## Troubleshooting | ||
|
||
### `npm start` doesn’t detect changes | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also let's add this to the main README, like we do for other top level sections.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍