docs
This commit is contained in:
1 parent
f6fb4aae9a
commit
c4d3b6b292
1 file changed
+28
-8
@@ -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.
|
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
|
## Endpoints
|
||||||
|
|
||||||
* GET `/admin` - upload form protected with Basic Auth
|
* 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` - serves JSON with upcoming 10 films for today
|
||||||
* GET `/api/screenings/prices` - serves JSON with pricing data
|
* 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
|
## Docker
|
||||||
|
|
||||||
Run the container with docker-compose:
|
Run the container with docker-compose:
|
||||||
|
|||||||
Reference in new issue
Block a user