diff --git a/README.md b/README.md index a1f1191..61d9043 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,9 @@ Eine Website, die sich von einer selber gehosteten Tandoor-Instanz die Shoppingl ## Inhalt - TODO -- Fsetlegungen - - - - +- Festlegungen +- Ablauf +- Installation ## TODO @@ -19,11 +17,34 @@ Eine Website, die sich von einer selber gehosteten Tandoor-Instanz die Shoppingl - [ ] Implementieren ## Festlegungen -*Hier muss noch beschrieben werden, wie genau das gemacht wird.* +- Database: SQLite3 mit sqlmodel +- API FastAPI +- Jinja +- TailwindCSS + Alpine.js +??? ## 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 & Setup +``` +git clone https://git.schamagusa.de/rudi/Tandur.git +cd Tandur + +source .venv/bin/activate +pip install --no-cache-dir -r requirements.txt +``` +##### Run +``` +uvicorn main:app +``` +### Docker Compose (recomended) +#TODO +