update readme with installation and tear-down instructions

This commit is contained in:
iwpnd 2020-01-29 13:45:20 +01:00
parent ba2dbf864d
commit 18dea07c06
2 changed files with 27 additions and 2 deletions

View File

@ -1,7 +1,32 @@
# streamlit-docker-example
Example on how to run and develop a streamlit application inside docker.
Example on how to run and develop a [streamlit](https://github.com/streamlit/streamlit) application inside docker.
<p align="center">
<img src="/img/screenshot.png" alt="streamlit in docker">
</p>
## Installation
```bash
git clone https://github.com/iwpnd/streamlit-docker-example.git
cd steamlit-docker-example
docker-compose up -d --build
```
The container will start in detached mode and can now be accessed via [localhost:8501](http://localhost:8501). Whenever you change the app/main.py the steamlit application will update too. If you want to build upon that example, just add your dependencies to the Dockerfile and rebuild the image using docker-compose.
After you are done, and you want to tear down the application, either
```bash
docker-compose stop
```
to stop the application, or use
```bash
docker-compose down --rmi all
```
to stop the application, remove the stopped containers and optionally `--rmi all` / remove all images associated in the docker-compose.yml file.

View File

@ -1,7 +1,7 @@
version: '3.7'
services:
api:
app:
build: ./
command: streamlit run app/main.py --server.port 8501
volumes: