(doc,chore) added readme, pin python version

This commit is contained in:
Nicolas Sebastian Schuler
2025-07-16 10:31:57 +02:00
parent 7cbcafbf6e
commit 7f1034a22f
2 changed files with 29 additions and 1 deletions

View File

@@ -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`.