diff --git a/README.md b/README.md index e69de29..b7ee60a 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,48 @@ +# 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. + +## 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. + +## 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. + +### 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. + +### Frontend +Für das Frontend wurde Vanilla-JS und CSS benutzt. + +## API Übersicht + +| Pfad | Zugelassene Methoden | Angesprochene Modelle | +| ----------------- | ------------------------ | --------------------- | +| `/api/lists` | GET, POST, DELETE, PATCH | Einkaufslisten | +| `/api/categories` | GET, POST, DELETE, PATCH | Kategorien | +| `/api/items` | GET, POST, DELETE, PATCH | Gegenstände | +Die vollständige API-Dokumentation befindet sich unter `/docs/`. +## Aufsetzen + +Auf der Maschine muss Java 25 und Maven installiert sein. + +``` +# Repo clonen +git clone https://gitea.von.timaldinger.de/Technoir/einkaufsliste-web.git +# Im Ordner +mvn spring-boot:run +``` +Nun kann man im Browser `localhost:8080` aufrufen. + +## Dokumentation +Weitere Dokumentation befindet sich unter `/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. +Konzept-, Architekturentscheidungen und Umsetzung des Projekts liegen an mir. +Vorschläge von KI wurden geprüft und bewusst übernommen oder verworfen. \ No newline at end of file