Skip to content

docs: add build.sh, streamlit to README #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 18, 2025
Merged

docs: add build.sh, streamlit to README #182

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/development/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,14 @@ cp .env.sample .env

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

## Run the build script

This builds the runtime and devcontainer images:

```shell
bin/build.sh
```

## Run the application

Start the application service with Compose:
Expand All @@ -155,6 +163,12 @@ Start the application service with Compose:
docker compose up -d web
```

Start the streamlit application with Compose:

```shell
docker compose up streamlit
```

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.

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

The VS Code window will reload into the devcontainer.

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

## Explore the devcontainer

Expand Down
Loading