Fixes #398 - added environment variables section to README
This commit is contained in:
Родитель
e26803a85b
Коммит
c6f5a68865
17
README.md
17
README.md
|
@ -11,7 +11,6 @@ This is a prototype to test a few ideas on how to gather a stream of things crea
|
|||
|
||||
- Staging: https://network-pulse-staging.herokuapp.com
|
||||
- Work is happening in the `master` branch.
|
||||
- Relevant tickets are marked with the `v2 (upcoming)` label.
|
||||
|
||||
### Requirements for Development
|
||||
|
||||
|
@ -26,6 +25,20 @@ This is a prototype to test a few ideas on how to gather a stream of things crea
|
|||
- `npm install`
|
||||
- `npm start`
|
||||
|
||||
### Environment Variables
|
||||
|
||||
#### `HOST`
|
||||
|
||||
The host you are using. e.g., `HOST=http://localhost`
|
||||
|
||||
#### `PORT`
|
||||
|
||||
The port number you are using. e.g., `PORT=3000`
|
||||
|
||||
#### `PULSE_API` (optional)
|
||||
|
||||
URL to your local Pulse API instance (if you have one set up). e.g., `PULSE_API=http://test.example.com:8000`
|
||||
|
||||
To set up a local instance of Pulse API, follow instructions on https://github.com/mozilla/network-pulse-api/blob/master/README.md.
|
||||
|
||||
## 🔷 More info
|
||||
|
@ -36,5 +49,3 @@ To set up a local instance of Pulse API, follow instructions on https://github.c
|
|||
## 🔷 Contribute
|
||||
|
||||
You can contribute by testing https://network-pulse-staging.herokuapp.com. File [issues](https://github.com/mozilla/network-pulse/issues) with bugs or suggestions.
|
||||
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче