Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit 0a48e8e

Browse files
authored
📚 clarify static.json at root of repo
1 parent 746eed2 commit 0a48e8e

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,8 @@ To customize an app's processes, commit a `Procfile` and deploy. Include `web: b
181181

182182
The web server may be [configured via the static buildpack](https://github.com/heroku/heroku-buildpack-static#configuration).
183183

184+
The config file `static.json` should be committed at the root of the repo. It will not be recognized, if this file in a sub-directory
185+
184186
The default `static.json`, if it does not exist in the repo, is:
185187

186188
```json
@@ -195,7 +197,7 @@ If a different web server `"root"` is specified, such as with a highly customize
195197

196198
[React Router](https://github.com/ReactTraining/react-router) (not included) may easily use hash-based URLs like `https://example.com/index.html#/users/me/edit`. This is nice & easy when getting started with local development, but for a public app you probably want real URLs like `https://example.com/users/me/edit`.
197199

198-
Create a `static.json` file to configure the web server for clean [`browserHistory` with React Router v3](https://github.com/ReactTraining/react-router/blob/v3/docs/guides/Histories.md#browserhistory) & [`BrowserRouter` with v4](https://reacttraining.com/react-router/web/api/BrowserRouter):
200+
Create a `static.json` file at the root of the repo to configure the web server for clean [`browserHistory` with React Router v3](https://github.com/ReactTraining/react-router/blob/v3/docs/guides/Histories.md#browserhistory) & [`BrowserRouter` with v4](https://reacttraining.com/react-router/web/api/BrowserRouter):
199201

200202
```json
201203
{

0 commit comments

Comments
 (0)