Skip to content

Commit

Permalink
[update] document the environment variables
Browse files Browse the repository at this point in the history
  • Loading branch information
sergiodxa committed Jan 16, 2017
1 parent 7da7f64 commit 844825b
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,15 @@ npm run start:prod
```

This will automatically run `npm run build` to generate the production ready files.

## Enviroment variables
- `NODE_ENV`: the envirment (default: `development`)
- `PORT`: the private port (default: `3000`)
- `HOST`: the private host (default: `localhost`)
- `P_PROT`: the public protocol (default: `http`)
- `P_PORT`: the public port (default: `3000`)
- `P_HOST`: the public host (default: `localhost`)

The private **port** and **host** are used to run the app inside a docker container.

The public **port**, **host** and **protocol** are used to fetch data from the server in the React application.

0 comments on commit 844825b

Please sign in to comment.