From 84b4efa521b7a926d3816e5518fcc479d97f6690 Mon Sep 17 00:00:00 2001 From: Moritz Kowalski Date: Tue, 3 Jun 2025 11:18:52 +0200 Subject: [PATCH] Update readme --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 631956c..29ee210 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,20 @@ Dieses Repository beinhaltet den Quellcode für die Website der Getränkeliste. Nach Problemen mit der Prepaid-Liste wird hier ein neuer Versuch gestartet, diese Liste ins digitale umzuwandeln. -## Features +## Development -### implementiert +Bereits integriert ist eine bile-based Datenbank basierend auf noSQL. Die Website wird gebaut mithilfe von uvicorn und FastAPI. -*keine* +Zum entwickeln und testen bietet uvicorn eine hot-reload Funktionalität an, das heißt ein neustarten des Services ist +auch nach Änderungen im Code nicht erforderlich. -### todo +```shell +uvicorn main:app --reload +``` -- SQL Datenbank anbindung -- SSO über OIDC -- Prepaid-Login über WebAuthn -- Admin Interface +In Produktion kann der Service ohne reload, aber mit mehr workers gestartet werden. Hier werden zusätzlich der Host +festgelegt und Flags für den Reverse Proxy gesetzt, welcher in der IP-Range `172.16.0.0/12` liegt. + +```shell +uvicorn --host "172.17.1.108" --port 8000 --workers 4 --proxy-headers --forwarded-allow-ips "172.16.0.0/12" main:app +```