(doc,chore) added readme, pin python version
This commit is contained in:
@@ -1 +1 @@
|
||||
3.12
|
||||
3.12.6
|
||||
|
||||
28
README.md
28
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`.
|
||||
|
||||
Reference in New Issue
Block a user