Skip to content

Commit a9accc7

Browse files
committed
update README
1 parent 0b0803e commit a9accc7

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,15 @@ Join out [Code For America](https://codeforphilly.org/projects/chime--covid-19_h
88
## Development
99
To test the app locally just run:
1010

11-
`streamlit run app.py`
11+
```sh
12+
streamlit run app.py
13+
```
1214

13-
This will open a browser window with the app running.
15+
This will open a browser window with the app running on port 8000. If you need the app to run on another port, you can edit `.streamlit/config.toml`, or use the magic ENV var, `STREAMLIT_SERVER_PORT` - see [this streamlit issue](https://github.com/streamlit/streamlit/pull/527). So, for example, to run the app on port 1234, you would change the last line of `config.toml` to `port = 1234` or invoke the app like this:
16+
17+
```sh
18+
STREAMLIT_SERVER_PORT=1234 streamlit run app.py
19+
```
1420

1521
### With `pipenv`
1622
```bash
@@ -19,7 +25,7 @@ pipenv install
1925
streamlit run app.py
2026
```
2127

22-
### With `conda`
28+
### With `conda`
2329
```bash
2430
conda create -f environment.yml
2531
source activate chime
@@ -36,9 +42,9 @@ docker-compose up
3642
```
3743

3844
You should be able to view the app via `localhost:8000`. If you want to change the
39-
port, then set `PORT` in the `.env` file.
45+
port (as described above), then you also have to set `PORT` in the `.env` file.
4046

41-
**NOTE** this is just for usage, not for development--- you would have to restart and possibly rebuild the app every time you change the code.
47+
**NOTE** this is just for usage, not for development--- you would have to restart and possibly rebuild the app every time you change the code.
4248

4349
## Deployment
4450
**Before you push your changes to master make sure that everything works in development mode.**

0 commit comments

Comments
 (0)