Skip to content

Commit

Permalink
docs(fr): add page
Browse files Browse the repository at this point in the history
  • Loading branch information
Ruidy committed Aug 12, 2021
1 parent 25a4828 commit 3040ad9
Show file tree
Hide file tree
Showing 2 changed files with 242 additions and 0 deletions.
240 changes: 240 additions & 0 deletions docs/fr/docs/deployment/deta.md
@@ -0,0 +1,240 @@
# Deploy FastAPI on Deta

In this section you will learn how to easily deploy a **FastAPI** application on <a href="https://www.deta.sh/?ref=fastapi" class="external-link" target="_blank">Deta</a> using the free plan. 🎁

It will take you about **10 minutes**.

!!! info
<a href="https://www.deta.sh/?ref=fastapi" class="external-link" target="_blank">Deta</a> is a **FastAPI** sponsor. 🎉

## A basic **FastAPI** app

* Create a directory for your app, for example `./fastapideta/` and enter in it.

### FastAPI code

* Create a `main.py` file with:

```Python
from fastapi import FastAPI

app = FastAPI()


@app.get("/")
def read_root():
return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int):
return {"item_id": item_id}
```

### Requirements

Now, in the same directory create a file `requirements.txt` with:

```text
fastapi
```

!!! tip
You don't need to install Uvicorn to deploy on Deta, although you would probably want to install it locally to test your app.

### Directory structure

You will now have one directory `./fastapideta/` with two files:

```
.
└── main.py
└── requirements.txt
```

## Create a free Deta account

Now create a <a href="https://www.deta.sh/?ref=fastapi" class="external-link" target="_blank">free account on Deta</a>, you just need an email and password.

You don't even need a credit card.

## Install the CLI

Once you have your account, install the Deta <abbr title="Command Line Interface application">CLI</abbr>:

=== "Linux, macOS"

<div class="termy">

```console
$ curl -fsSL https://get.deta.dev/cli.sh | sh
```

</div>

=== "Windows PowerShell"

<div class="termy">

```console
$ iwr https://get.deta.dev/cli.ps1 -useb | iex
```

</div>

After installing it, open a new terminal so that the installed CLI is detected.

In a new terminal, confirm that it was correctly installed with:

<div class="termy">

```console
$ deta --help

Deta command line interface for managing deta micros.
Complete documentation available at https://docs.deta.sh

Usage:
deta [flags]
deta [command]

Available Commands:
auth Change auth settings for a deta micro

...
```

</div>

!!! tip
If you have problems installing the CLI, check the <a href="https://docs.deta.sh/docs/micros/getting_started?ref=fastapi" class="external-link" target="_blank">official Deta docs</a>.

## Login with the CLI

Now login to Deta from the CLI with:

<div class="termy">

```console
$ deta login

Please, log in from the web page. Waiting..
Logged in successfully.
```

</div>

This will open a web browser and authenticate automatically.

## Deploy with Deta

Next, deploy your application with the Deta CLI:

<div class="termy">

```console
$ deta new

Successfully created a new micro

// Notice the "endpoint" 🔍

{
"name": "fastapideta",
"runtime": "python3.7",
"endpoint": "https://qltnci.deta.dev",
"visor": "enabled",
"http_auth": "enabled"
}

Adding dependencies...


---> 100%


Successfully installed fastapi-0.61.1 pydantic-1.7.2 starlette-0.13.6
```

</div>

You will see a JSON message similar to:

```JSON hl_lines="4"
{
"name": "fastapideta",
"runtime": "python3.7",
"endpoint": "https://qltnci.deta.dev",
"visor": "enabled",
"http_auth": "enabled"
}
```

!!! tip
Your deployment will have a different `"endpoint"` URL.

## Check it

Now open your browser in your `endpoint` URL. In the example above it was `https://qltnci.deta.dev`, but yours will be different.

You will see the JSON response from your FastAPI app:

```JSON
{
"Hello": "World"
}
```

And now go to the `/docs` for your API, in the example above it would be `https://qltnci.deta.dev/docs`.

It will show your docs like:

<img src="/img/deployment/deta/image01.png">

## Enable public access

By default, Deta will handle authentication using cookies for your account.

But once you are ready, you can make it public with:

<div class="termy">

```console
$ deta auth disable

Successfully disabled http auth
```

</div>

Now you can share that URL with anyone and they will be able to access your API. 🚀

## HTTPS

Congrats! You deployed your FastAPI app to Deta! 🎉 🍰

Also notice that Deta correctly handles HTTPS for you, so you don't have to take care of that and can be sure that your clients will have a secure encrypted connection. ✅ 🔒

## Check the Visor

From your docs UI (they will be in a URL like `https://qltnci.deta.dev/docs`) send a request to your *path operation* `/items/{item_id}`.

For example with ID `5`.

Now go to <a href="https://web.deta.sh/" class="external-link" target="_blank">https://web.deta.sh</a>.

You will see there's a section to the left called <abbr title="it comes from Micro(server)">"Micros"</abbr> with each of your apps.

You will see a tab with "Details", and also a tab "Visor", go to the tab "Visor".

In there you can inspect the recent requests sent to your app.

You can also edit them and re-play them.

<img src="/img/deployment/deta/image02.png">

## Learn more

At some point you will probably want to store some data for your app in a way that persists through time. For that you can use <a href="https://docs.deta.sh/docs/base/py_tutorial?ref=fastapi" class="external-link" target="_blank">Deta Base</a>, it also has a generous **free tier**.

You can also read more in the <a href="https://docs.deta.sh?ref=fastapi" class="external-link" target="_blank">Deta Docs</a>.
2 changes: 2 additions & 0 deletions docs/fr/mkdocs.yml
Expand Up @@ -58,6 +58,8 @@ nav:
- python-types.md
- Tutoriel - Guide utilisateur:
- tutorial/background-tasks.md
- Deploiement:
- deployment/deta.md
- project-generation.md
- alternatives.md
- external-links.md
Expand Down

0 comments on commit 3040ad9

Please sign in to comment.