📚 clarifications
This commit is contained in:
17
README.md
17
README.md
@@ -2,28 +2,29 @@
|
||||
|
||||
Example app combining a React UI (from [create-react-app](https://github.com/facebookincubator/create-react-app)) with a custom Node/Express server.
|
||||
|
||||
If you simply want to deploy a React app, try [create-react-app-buildpack](https://github.com/mars/create-react-app-buildpack).
|
||||
To simply deploy a React app, try [create-react-app-buildpack](https://github.com/mars/create-react-app-buildpack).
|
||||
|
||||
|
||||
## Design Points
|
||||
|
||||
* Node server
|
||||
* [Node server](server/)
|
||||
* [`package.json`](package.json), at the root
|
||||
* `postinstall` script performs React app's `npm install` on deploy to Heroku
|
||||
* `cacheDirectories` includes `react-ui/node_modules/` to speed up subsequent deploys to Heroku
|
||||
* serves `../react-ui/build/` as static files
|
||||
* `npm` works normally
|
||||
* React app
|
||||
* [React app](react-ui/)
|
||||
* [`react-ui/package.json`](react-ui/package.json), in a subdirectory
|
||||
* as generated by create-react-app
|
||||
* plus the `proxy` config enables dual-process (hot-reloading React UI + Node API) for local development
|
||||
* `npm` must be run against the subdirectory
|
||||
* use the prefix option, `npm start --prefix react-ui`, or
|
||||
* change directories `cd react-ui/` to use `npm`
|
||||
* Heroku
|
||||
* **heroku/node** buildpack will auto-detect via `package.json`
|
||||
* `npm install` for server & `postinstall` for React UI will automatically run
|
||||
* `npm start` will automatically launch
|
||||
* [deploy to Heroku](https://devcenter.heroku.com/categories/deployment)
|
||||
* automatically:
|
||||
* detects [Node](https://elements.heroku.com/buildpacks/heroku/heroku-buildpack-nodejs) from `package.json`
|
||||
* builds with `npm install` for server & `postinstall` for React UI
|
||||
* launches web process with `npm start`
|
||||
|
||||
|
||||
## Punchline
|
||||
@@ -70,4 +71,4 @@ npm install --prefix react-ui
|
||||
|
||||
# Start the server
|
||||
npm start --prefix react-ui
|
||||
```
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user