diff --git a/Preview/ex1.png b/Preview/ex1.png new file mode 100644 index 0000000..72feea2 Binary files /dev/null and b/Preview/ex1.png differ diff --git a/Preview/ex2.png b/Preview/ex2.png new file mode 100644 index 0000000..497122c Binary files /dev/null and b/Preview/ex2.png differ diff --git a/Preview/ex3.png b/Preview/ex3.png new file mode 100644 index 0000000..b3cdf26 Binary files /dev/null and b/Preview/ex3.png differ diff --git a/Preview/ex4.png b/Preview/ex4.png new file mode 100644 index 0000000..a609c3f Binary files /dev/null and b/Preview/ex4.png differ diff --git a/README.md b/README.md index 0b495cb..7e8f818 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,60 @@ # Guestlist -Minimale Guestlist-App mit Admin/Maintainer-Login, Guest-Access-Code und MongoDB. +Minimal guest list app with admin/maintainer login, guest access code and MongoDB. -## Schnellstart mit Docker Compose +## Preview + +![Guestlist preview 1](Preview/ex1.png) + +![Guestlist preview 2](Preview/ex2.png) + +![Guestlist preview 3](Preview/ex3.png) + +![Guestlist preview 4](Preview/ex4.png) + +## Quick Start With Docker Compose ```bash docker compose up -d --build ``` -App öffnen: +Open the app: ```text http://localhost:8080 ``` -Beim ersten Start: +On first startup: ```text http://localhost:8080/setup ``` -Dort den ersten Admin und den Guest Access Code anlegen. +Create the first admin user and the guest access code there. -## Nützliche Befehle +## Useful Commands -Logs anzeigen: +Show logs: ```bash docker compose logs -f app ``` -Stoppen: +Stop: ```bash docker compose down ``` -Stoppen und MongoDB-Daten löschen: +Stop and delete MongoDB data: ```bash docker compose down -v ``` -## Konfiguration +## Configuration -Die App wird im Container über Environment Variables konfiguriert: +The app is configured in the container through environment variables: ```yaml Mongo__ConnectionString: mongodb://mongo:27017 @@ -52,6 +62,6 @@ Mongo__DatabaseName: guestlist ASPNETCORE_URLS: http://+:8080 ``` -MongoDB-Daten liegen im Compose-Volume `mongo_data`. +MongoDB data is stored in the Compose volume `mongo_data`. -Beim Reset im Admin-Bereich kopiert die App die aktuelle Datenbank zuerst in eine neue Backup-Datenbank mit dem Muster `guestlist_backup_`. Danach wird die aktive Datenbank frisch angelegt und das Setup ist wieder offen. Auf der Setup-Seite kann das letzte Datenbank-Backup wiederhergestellt werden. +When setup is reset in the admin area, the app first copies the current database into a new backup database using the pattern `guestlist_backup_`. After that, the active database is recreated and setup is open again. The latest database backup can be restored from the setup page.