From a30058d6cb04869cb18589b59808559d4436d013 Mon Sep 17 00:00:00 2001
From: Mark Hoekveen <mark@hoekveen.net>
Date: Tue, 5 Mar 2024 11:35:20 +0100
Subject: [PATCH] Readme and example env update More "docs" more better.

---
 README.md   | 35 +++++++++++++++++++++++++++++++++++
 example.env |  2 ++
 2 files changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ad6bd82
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# HDcon Muzak
+> Gewoon een leuk tooltje om samen met je vrienden een muzieklijst samen te stellen.
+## Features
+* Stuur een spotify-link in om een nummer te nomineren
+* Beluister en stem op de ingestuurde nummers
+* Aan het einde heb je een mooie playlist
+* AI-enabled. De toekomst is nu.
+## Installatie
+* Zie `requirements.txt`
+* Message queue voor Celery, bijvoorbeeld [RabbitMQ](https://www.rabbitmq.com/)
+* Optioneel [taalmodelletje](https://ollama.com/), wat ook op een andere server mag staan.
+## Configuratie
+Zie `example.env` voor alle environment variabelen die moeten worden ingevuld.
+
+Waarschijnlijk hoef je niet zo heel veel te doen aan `settings.py`, maar let op bij een deployment.
+
+### Authenticatie
+Technisch gezien verloopt de auth via single-sign-on OIDC, maar je kan via het /admin eindpunt ook nog inloggen met local auth als je [zelf een lokale user hebt aangemaakt](https://docs.djangoproject.com/en/5.0/intro/tutorial02/#creating-an-admin-user).
+## Development
+Maak migraties en pas ze toe:
+> `python manage.py makemigrations`\
+`python manage.py migrate`
+
+Start je message broker en een celery worker:
+> `sudo systemctl start rabbitmq`\
+`celery -A muzak worker -l INFO`
+
+Start development server met:
+> `python manage.py runserver`
+
+## Belangrijke upstream documentatie
+* https://docs.celeryq.dev/en/stable/
+* https://docs.djangoproject.com/en/5.0/
+* https://github.com/ollama/ollama/tree/main/docs
+* https://htmx.org/docs/
\ No newline at end of file
diff --git a/example.env b/example.env
index c0e63b3..b863579 100644
--- a/example.env
+++ b/example.env
@@ -4,3 +4,5 @@ OIDC_RP_CLIENT_SECRET=<OIDC-Client-Secret>
 OIDC_OP_AUTHORIZATION_ENDPOINT=https://auth.yourwebsite.com/application/o/authorize/
 OIDC_OP_TOKEN_ENDPOINT=https://auth.yourwebsite.com/application/o/token/
 OIDC_OP_USER_ENDPOINT=https://auth.yourwebsite.com/application/o/userinfo/
+AI_ENDPOINT=http://localhost:11434/api/generate
+AI_MODEL=myModel
\ No newline at end of file