zeilenlänge, LEerzeilen und verweis auf docs hinzugefügt
This commit is contained in:
Technoir committed 2026-10-19 16:04:24 +02:00
1 parent e22cd8c650
commit 179ec1206b
1 file changed
+26 -8
+26 -8
View File
@@ -1,22 +1,39 @@
# Einkaufsliste
Repository für das Webapp-Projekt, was eine Einkaufsliste zur Verfügung stellt.
Es ist möglich, mehrere Listen anzulegen. In einer Liste kann man Gegenstände und Kategorien erstellen. Gegenständen können, aber müssen nicht Kategorien gehören.
Es ist möglich, mehrere Listen anzulegen. In einer Liste kann man
Gegenstände und Kategorien erstellen.
Gegenständen können, aber müssen nicht Kategorien gehören.
## Dokumentation
### Entwicklungsverlauf und User Stories
Dieses Projekt hat seine Dokumentation über Gitea vorgenommen. Die Entwicklungshistorie ist über die Commitliste einsehbar, User-Stories und andere Entwicklungsentscheidungen wurden über Issues abgewickelt. Es wurden auch Meilensteine verwendet um die Issues zu organisieren.
Dieses Projekt hat seine Dokumentation über Gitea vorgenommen.
Die Entwicklungshistorie ist über die Commitliste einsehbar,
User-Stories, Erweiterungen/Änderungen am Projekt und andere
Entwicklungsentscheidungen wurden über Issues abgewickelt.
Es wurden auch Meilensteine verwendet um die Issues zu organisieren.
Bugs und Fehler wurden nicht mit Issues dokumentiert, da
sie entweder während der Entwicklung auf einem anderen Branch beseitigt worden sind
(wenn der Fehler von der Entwicklung des Branches kam) oder spontan gefixt.
Die Commits, welche Bugs fixen sind mit `bug:` bzw. `bugfix:`
gekennzeichnet und in der Commit-Historie auffindbar.
## Architektur
Die Seite verfolgt einen clientseitig gerenderter Ansatz. Das Backend schickt dem Browser eine HTML-Datei, welche in Teilen mit Attributen bei Custom Elementen und Daten befüllt sind. Der Client rendert dann die Custom Elemente.
Die Webseite selbst ist so ziemlich im Frontend benutzbar. Ein Neuladen der Seite ist nicht nötig, mit Ausnahme wenn man zwischen Listen und der Listenübersicht wechselt.
Die Seite verfolgt einen hybriden Ansatz. Das Backend schickt dem Browser eine HTML-Datei,
welche in Teilen mit Attributen bei Custom Elementen und Daten befüllt sind.
Der Client rendert dann die Custom Elemente.
Die Webseite selbst ist so ziemlich im Frontend benutzbar.
Ein Neuladen der Seite ist nicht nötig, mit Ausnahme wenn man
zwischen Listen und der Listenübersicht wechselt.
### Backend
Für das Backend wurde Spring mit Thymeleaf für das Bereitstellen von Seiten genutzt (`src/main/java/de/timaldinger/einkaufsliste`). Das Backend ist über eine RESTful-API ansprechbar. Die Datenbank ist H2.
Für das Backend wurde Spring mit Thymeleaf für das Bereitstellen von Seiten genutzt (`src/main/java/de/timaldinger/einkaufsliste`).
Das Backend ist über eine RESTful-API ansprechbar. Die Datenbank ist H2.
### Frontend
@@ -31,7 +48,7 @@ Hinweis: Kategorien und Gegenstände können bearbeitet werden indem man auf sie
| `/api/categories` | GET, POST, DELETE, PATCH | Kategorien |
| `/api/items` | GET, POST, DELETE, PATCH | Gegenstände |
Die vollständige API-Dokumentation befindet sich unter `/docs/`.
Die vollständige API-Dokumentation befindet sich unter [`/docs/`](/docs/API.md)
## Aufsetzen
@@ -50,10 +67,11 @@ Nun kann man im Browser `localhost:8080` aufrufen.
### Weitere Dokumentation
Weitere Dokumentation befindet sich unter `/docs/`
Weitere Dokumentation befindet sich unter [`/docs/`](/docs)
### Nutzung von KI
Es wurde Claude Code Opus 4.8 genutzt. Die KI wurde benutzt zum Debuggen bei scheinbar nicht erkennbaren Fehlern, großen Refactors und als Nachschlagwerk genutzt.
Es wurde Claude Code Opus 4.8 genutzt. Die KI wurde zum Debuggen,
bei scheinbar nicht erkennbaren Fehlern, großen Refactors und als Nachschlagewerk genutzt.
Konzept-, Architekturentscheidungen und Umsetzung des Projekts liegen an mir.
Vorschläge von KI wurden geprüft und bewusst übernommen oder verworfen.