diff --git a/README.md b/README.md index b8fb081..1b6ab89 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ See deployed at http://ivanc.uk 2. A [Django server app](/server) that assists the React app by providing data via a REST API. See deployed at https://api.ivanc.uk -## React app +## Getting started with React app Source code located under `/web-client`. This React app is set up with [Webpack](https://webpack.github.io/) and [Express](http://expressjs.com/) so that the React components are rendered in the server side. @@ -19,7 +19,7 @@ Source code located under `/web-client`. This React app is set up with [Webpack] 5. Modify any of the components under [`/src`](web-client/src) and see the changes in real time thanks to [React Hot loader](https://github.com/gaearon/react-hot-loader) -#### Deployment +#### Deployment of React app This app can be deployed as a Node application on Heroku or Dokku. There is a `heroku-postbuild` script in [`package.json`](web-client/package.json) so every time the app is pushed to Heroku, Webpack compiles the JavaScript code in production mode. Webpack outputs the result into `public/bundle.js` that is loaded @@ -27,7 +27,7 @@ from [`index.html`](web-client/index.html). This `index.html` file is then serve requested. See [`server.js`](web-client/server.js) for more details. There are a couple of **environment variables** that need setting up before deploying: -* `API_BASE_URL`: The URL where the Django server app is deployed. e.g. https://api.ivanc.uk/ +* `API_BASE_URL`: The URL where the Django server app is deployed. for e.g. https://api.ivanc.uk/ * `GA_TRACKING_CODE`: Your Google Analytics tracking code.