From 1478427508135970c9c02e2eecc3e34a58377c8f Mon Sep 17 00:00:00 2001
From: Lorenz Zahn <lorenz.zahn@student.uni-halle.de>
Date: Sun, 3 Sep 2023 17:19:59 +0200
Subject: [PATCH] Dokumentation
---
README.md | 3 ++
app/requirements.txt | 2 +-
docs/hinweise_betrieb.md | 14 ++++++
docs/receipt_template.json | 98 --------------------------------------
4 files changed, 18 insertions(+), 99 deletions(-)
create mode 100644 docs/hinweise_betrieb.md
delete mode 100644 docs/receipt_template.json
diff --git a/README.md b/README.md
index e69de29b..4f8392de 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,3 @@
+# Vollkostenkalkulation: Digittime
+
+Dies ist das Git-Repository des Projekts Digitime.
\ No newline at end of file
diff --git a/app/requirements.txt b/app/requirements.txt
index fc620109..0b4c0747 100644
--- a/app/requirements.txt
+++ b/app/requirements.txt
@@ -1,3 +1,3 @@
-Django
+Django<=5.0
gunicorn
psycopg2-binary
\ No newline at end of file
diff --git a/docs/hinweise_betrieb.md b/docs/hinweise_betrieb.md
new file mode 100644
index 00000000..aa36fd67
--- /dev/null
+++ b/docs/hinweise_betrieb.md
@@ -0,0 +1,14 @@
+# Hinweise für den Betrieb
+
+Für den erfolgreichen Betrieb der Anwendung werden einige Hinweise gegeben.
+
+## Datenbank
+Die Datenbank- (`db`) und der Backupservice (`cron`) basieren auf dem Dockerimage `14-alpine`. Sollte die Unterstützung für Postgresql 14 auslaufen, muss die Datenbank auf eine höhere Version migriert werden. Hierzu ist die offizielle [Dokumentation](https://www.postgresql.org/docs/current/upgrading.html) zu beachten.
+
+## Django
+Die Webapplikation basiert auf Django (4.2). Im Rahmen der Entwicklung wurde acht gegeben, keine als auslaufend markierte Features zu verwenden. Bis zum aktuellen Stand kann die Anwendung bis Django 5.0 betrieben problemlos werden. Für höheren Versionen kann keine Garantie gegeben werden.
+
+Wann ein entsprechendes Feature ausläuft, kann der [Django Deprecation Timeline](https://docs.djangoproject.com/en/4.2/internals/deprecation/) entnommen werden.
+
+## Docker, Docker Compose und weitere
+Im Laufe der kommenden Jahren ist mit einem Wandel der Abhängigkeiten zu rechnen. Entsprechende Aktualisierungen sollten aus dem Aspekt der Datensicherheit durchgeführt werden. Anpassungen des Projekt müssen hierbei abgewogen werden.
\ No newline at end of file
diff --git a/docs/receipt_template.json b/docs/receipt_template.json
deleted file mode 100644
index d22f52f7..00000000
--- a/docs/receipt_template.json
+++ /dev/null
@@ -1,98 +0,0 @@
-[
- { "Betrieb" : [
- { "method" : "FIXED", "value": "1" },
- { "method" : "FIXED", "value": "1" },
- { "method" : "FIXED", "value": "1" },
- { "method" : "FIXED", "value": "1" },
- { "method" : "FIXED", "value": "1" },
- { "method" : "FIXED", "value": "1" }
- ]},
- { "Belegnr" : [
- { "method" : "GENERATED", "value" : "receipt_number" },
- { "method" : "GENERATED", "value" : "receipt_number" },
- { "method" : "GENERATED", "value" : "receipt_number" },
- { "method" : "GENERATED", "value" : "receipt_number" },
- { "method" : "GENERATED", "value" : "receipt_number" },
- { "method" : "GENERATED", "value" : "receipt_number" }
- ]},
- { "Datum" : [
- { "method" : "GENERATED", "value" : "end" },
- { "method" : "GENERATED", "value" : "end" },
- { "method" : "GENERATED", "value" : "end" },
- { "method" : "GENERATED", "value" : "end" },
- { "method" : "GENERATED", "value" : "end" },
- { "method" : "GENERATED", "value" : "end" }
- ]},
- { "Jahr" : [
- { "method" : "GENERATED", "value" : "end.year" },
- { "method" : "GENERATED", "value" : "end.year" },
- { "method" : "GENERATED", "value" : "end.year" },
- { "method" : "GENERATED", "value" : "end.year" },
- { "method" : "GENERATED", "value" : "end.year" },
- { "method" : "GENERATED", "value" : "end.year" }
- ]},
- { "BUPER" : [
- { "method" : "GENERATED", "value" : "buper" },
- { "method" : "GENERATED", "value" : "buper" },
- { "method" : "GENERATED", "value" : "buper" },
- { "method" : "GENERATED", "value" : "buper" },
- { "method" : "GENERATED", "value" : "buper" },
- { "method" : "GENERATED", "value" : "buper" }
- ]},
- { "BA" : [
- { "method" : "FIXED", "value" : "SA" },
- { "method" : "FIXED", "value" : "SA" },
- { "method" : "FIXED", "value" : "SA" },
- { "method" : "FIXED", "value" : "SA" },
- { "method" : "FIXED", "value" : "SA" },
- { "method" : "FIXED", "value" : "SA" }
- ]},
- { "KontoS" : [
- { "method" : "FIXED", "value" : "755000" },
- { "method" : "FIXED", "value" : "999980" },
- { "method" : "FIXED", "value" : "755000" },
- { "method" : "FIXED", "value" : "999980" },
- { "method" : "FIXED", "value" : "755000" },
- { "method" : "FIXED", "value" : "999980" }
- ]},
- { "KontoH" : [
- { "method" : "FIXED", "value" : "999980" },
- { "method" : "FIXED", "value" : "562000" },
- { "method" : "FIXED", "value" : "999980" },
- { "method" : "FIXED", "value" : "562010" },
- { "method" : "FIXED", "value" : "999980" },
- { "method" : "FIXED", "value" : "562020" }
- ]},
- { "Betrag" : [
- { "method" : "GENERATED", "value" : "data.salary_costs_annotated.costs_sum" },
- { "method" : "GENERATED", "value" : "data.salary_costs_annotated.costs_sum" },
- { "method" : "GENERATED", "value" : "data.department_costs.salary_costs" },
- { "method" : "GENERATED", "value" : "data.department_costs.salary_costs" },
- { "method" : "GENERATED", "value" : "data.general_costs.total" },
- { "method" : "GENERATED", "value" : "data.general_costs.total" }
- ]},
- { "KSTS" : [
- { "method" : "GENERATED", "value" : "data.project.invoice_number" },
- { "method" : "GENERATED", "value" : "data.department.invoice_number" },
- { "method" : "GENERATED", "value" : "data.project.invoice_number" },
- { "method" : "GENERATED", "value" : "data.department.invoice_number" },
- { "method" : "GENERATED", "value" : "data.project.invoice_number" },
- { "method" : "FIXED", "value" : "770310" }
- ]},
- { "Btext1" : [
- { "method" : "FIXED", "value" : "Zuordn. GK n. SZ u. VKK" },
- { "method" : "FIXED", "value" : "Zuordn. GK n. SZ u. VKK" },
- { "method" : "FIXED", "value" : "Zuordn. GK n. SZ u. VKK" },
- { "method" : "FIXED", "value" : "Zuordn. GK n. SZ u. VKK" },
- { "method" : "FIXED", "value" : "Zuordn. GK n. SZ u. VKK" },
- { "method" : "FIXED", "value" : "Zuordn. GK n. SZ u. VKK" }
- ]},
- { "Btext2" : [
- { "method" : "GENERATED", "value" : "PGK end data.project.invoice_number" },
- { "method" : "GENERATED", "value" : "PGK end data.project.invoice_number" },
- { "method" : "GENERATED", "value" : "SGK end data.project.invoice_number" },
- { "method" : "GENERATED", "value" : "SGK end data.project.invoice_number" },
- { "method" : "GENERATED", "value" : "VGK end data.project.invoice_number" },
- { "method" : "GENERATED", "value" : "VGK end data.project.invoice_number" }
- ]}
-]
\ No newline at end of file
--
GitLab