Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 2.74 KB

README.md

File metadata and controls

67 lines (47 loc) · 2.74 KB

einkaufszettel-server

ChangelogSpezifikation (JSON-Schema)API (Swagger)

english version

einkaufszettel-Server ist die Serverkomponente für eine verteilte Anwendung zum einfachen und anonymen Teilen von Einkaufszetteln. Eine Anmeldung ist nicht nötig. Ein Einkaufszettel wird eindeutig über eine UUID identifiziert, über diese kann der Einkaufszettel von einem einkaufszettel-server geteilt werden. Jeder der die eindeutige ID des Einkaufszettels kennt, kann ihn lesen, verändern oder löschen. Eine Testinstanz steht unter https//ez.nachtsieb.de zur Verfügung.

Ein Desktop-Client befindet sich in Entwicklung.

Installation

Für ein einfaches Deployment steht ein Docker-Compose-Files bereit.

docker-compose up -d

Der einkaufszettel-server-API steht im Anschluss unter URL http://127.0.0.1:18080/r0 zur Verfügung.

Möchte man die Applikation hingegen ohne Container betreiben, benötigt man mindestens Version 11 des Java Runtime Environments. Eine Anleitung um einkaufszettel-server ohne Docker zu betreiben befindet sich hier. Die Anleitung befasst sich auch mit der Konfiguration der Datenbank und enthält eine Service-Definition für Systemd.

Einkaufszettel (Spezifikation)

Die Spezifikation eines Einkaufszettels is als JSON Schema draft version 4 verfasst: Einkaufszettel-Spezifikation.

REST-API

die interaktive API-Dokumentation (Swagger) greift auf die Testinstanz https://ez.nachtsieb.de zu.

Die Dokumentation der einkaufszettel API steht als OpenAPIv3-Spezifikation bereit.

Changelog

CHANGELOG

Verwendete Bibliotheken