From c4d3b6b2922d5f2df9a4e0f11e3aec68a30afb2b Mon Sep 17 00:00:00 2001 From: dreamer Date: Mon, 19 Oct 2026 15:01:09 +0200 Subject: [PATCH] docs --- README.md | 36 ++++++++++++++++++++++++++++-------- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fc9ac19..dcdd229 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,6 @@ Backend has an API with a main ticketing booth overview and theater hall specifi The endpoint serves the 10 upcoming screenings for the day. The frontend automatically refreshes to update its view with the current information. -## Run - -For development run the application locally: - -```sh -poetry run uvicorn fdhview.main:app --reload -``` - ## Endpoints * GET `/admin` - upload form protected with Basic Auth @@ -27,6 +19,34 @@ poetry run uvicorn fdhview.main:app --reload * GET `/api/screenings` - serves JSON with upcoming 10 films for today * GET `/api/screenings/prices` - serves JSON with pricing data +## Run + +For development run the application locally: + +```sh +poetry run uvicorn fdhview.main:app --reload +``` + +## Tests + +Test suite: + +```sh +poetry run pytest +``` + +Style checks: + +```sh +poetry run ruff check +``` + +Type checking: + +```sh +poetry run mypy . +``` + ## Docker Run the container with docker-compose: