diff --git a/.python-version b/.python-version index e4fba21..35f236d 100644 --- a/.python-version +++ b/.python-version @@ -1 +1 @@ -3.12 +3.12.6 diff --git a/README.md b/README.md index e69de29..176c49c 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,28 @@ +# Simple Notification Forwarding Application + +This Application is a simple REST-API for forwarding notifications. + +## Preperations for Virtual Environment + +```bash +git clone https://git.n-schuler.dev/nicolas/challenge_cloud_accelerator.git +cd challenge_cloud_accelerator +uv venv .venv && source .venv/bin/activate +uv sync +``` + +## Usage + +```bash + fastapi run app/main.py +``` + +## Testing +```bash + source .venv/bin/activate + pytest +``` + +## Documentation + +The OpenAPI Documentation is available at `0.0.0.0:8000/docs`.