Skip to content

Commit e4c585b

Browse files
docs: add build.sh, streamlit to README (#182)
2 parents b196341 + 16d33e0 commit e4c585b

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/development/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,14 @@ cp .env.sample .env
147147

148148
Feel free to inspect the environment file, but leave the defaults for now.
149149

150+
## Run the build script
151+
152+
This builds the runtime and devcontainer images:
153+
154+
```shell
155+
bin/build.sh
156+
```
157+
150158
## Run the application
151159

152160
Start the application service with Compose:
@@ -155,6 +163,12 @@ Start the application service with Compose:
155163
docker compose up -d web
156164
```
157165

166+
Start the streamlit application with Compose:
167+
168+
```shell
169+
docker compose up streamlit
170+
```
171+
158172
The `-d` flag starts the service in "detatched" mode, so your terminal is still available for additional commands. Without this flag, your terminal attaches to the service container's standard output.
159173

160174
The application is now running on `http://localhost:8000`.
@@ -184,7 +198,7 @@ If you don't see this notification, or if you dismissed it, use the VS Code Quic
184198

185199
The VS Code window will reload into the devcontainer.
186200

187-
Once loaded, hit `F5` to start the application in debug mode. The application is now running on `http://localhost:8000`.
201+
Once loaded, hit `F5` to start the application in debug mode. The application is now running on `http://localhost:8001`.
188202

189203
## Explore the devcontainer
190204

0 commit comments

Comments
 (0)