diff --git a/README.md b/README.md index a1f1191..15eea56 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ Eine Website, die sich von einer selber gehosteten Tandoor-Instanz die Shoppingl ## Inhalt - TODO -- Fsetlegungen +- Festlegungen +- Ablauf +- Installation @@ -17,13 +19,34 @@ Eine Website, die sich von einer selber gehosteten Tandoor-Instanz die Shoppingl - [ ] Next.js -> Frontend ? - [ ] Python -> Backend - [ ] Implementieren +- [ ] README in English and German ## Festlegungen -*Hier muss noch beschrieben werden, wie genau das gemacht wird.* +- API: FastApi +- Jinja +- TailwindCSS +- Alpine.js +- DB-ORM: sqlmodel ## Ablauf - Data fetch from Tandoor via APIs - Data fetch from Database - View on Website and edit - Order vie Mail -- CSV download *optional \ No newline at end of file +- CSV download *optional + +## Installation +### Bare metal +##### Linux +**Download and Setup** +``` +git clone https://git.schamagusa.de/rudi/Tandur.git +cd Tandur + +source .venv/bin/activate #activate.fish if you are using fish-shell +pip install -r requirements.txt +``` +**Running** +``` +uvicorn main:app --restart +```