awesome-compose/fastapi/README.md
Valon Januzaj b7685ad15f
Add fastapi to the list of compose projects
* Fastapi base Dockerfile
* requirements.txt for fastapi project
* Add documentation on how to run the application
* Add entrypoint for fastapi application
* Add docker-compose.yml for fastapi

Signed-off-by: vjanz <valon.januzaj98@gmail.com>
2021-10-10 23:38:34 +02:00

56 lines
1.1 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/FastAPI application
Project structure:
```
├── docker-compose.yaml
├── Dockerfile
├── requirements.txt
├── app
   ├── main.py
   ├── __init__.py
```
[_docker-compose.yaml_](docker-compose.yaml)
```
services:
api:
build: .
container_name: fastapi-application
environment:
PORT: 8000
ports:
- '8000:8000'
restart: "no"
```
## Deploy with docker-compose
```shell
docker-compose up -d --build
```
## Expected result
Listing containers must show one container running and the port mapping as below:
```
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
7087a6e79610 5c1778a60cf8 "/start.sh" About a minute ago Up About a minute 80/tcp, 0.0.0.0:8000->8000/tcp, :::8000->8000/tcp fastapi-application
```
After the application starts, navigate to `http://localhost:8000` in your web browser and you should see the following json response:
```
{
"message": "OK"
}
```
Stop and remove the containers
```
$ docker-compose down
```