awesome-compose/flask/README.md
Nick Sieger ee90e1c8a9
readme: add devenvs links in READMEs
Signed-off-by: Nick Sieger <nick@nicksieger.com>
2022-08-26 15:01:02 -05:00

71 lines
2.5 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## Compose sample application
### Python/Flask application
Project structure:
```
.
├── compose.yaml
├── app
   ├── Dockerfile
   ├── requirements.txt
   └── app.py
```
[_compose.yaml_](compose.yaml)
```
services:
web:
build:
context: app
target: builder
ports:
- '8000:8000'
```
## Deploy with docker compose
```
$ docker compose up -d
[+] Building 1.1s (16/16) FINISHED
=> [internal] load build definition from Dockerfile 0.0s
... 0.0s
=> => naming to docker.io/library/flask_web 0.0s
[+] Running 2/2
⠿ Network flask_default Created 0.0s
⠿ Container flask-web-1 Started
```
## Expected result
Listing containers must show one container running and the port mapping as below:
```
$ docker compose ps
NAME COMMAND SERVICE STATUS PORTS
flask-web-1 "python3 app.py" web running 0.0.0.0:8000->8000/tcp
```
After the application starts, navigate to `http://localhost:8000` in your web browser or run:
```
$ curl localhost:8000
Hello World!
```
Stop and remove the containers
```
$ docker compose down
```
## Use with Docker Development Environments
You can use this sample with the Dev Environments feature of Docker Desktop version 4.10 or later.
* [Open in Docker Dev Environments <img src="../open_in_new.svg" alt="Open in Docker Dev Environments" align="top"/>](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/flask) (works in Docker Desktop 4.12 and later versions)
* In the "Create a Dev Environment" wizard, choose "Existing Git Repo", copy the URL below and paste into the Git Repository field.
```
https://github.com/docker/awesome-compose/tree/master/flask
```
![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png)