changed readme to english and added preview images

This commit is contained in:
BeatriceAl
2026-05-11 23:26:53 +02:00
parent 5d37788a2c
commit 6931d1e626
5 changed files with 23 additions and 13 deletions
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 129 KiB

+23 -13
View File
@@ -1,50 +1,60 @@
# Guestlist # 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 ```bash
docker compose up -d --build docker compose up -d --build
``` ```
App öffnen: Open the app:
```text ```text
http://localhost:8080 http://localhost:8080
``` ```
Beim ersten Start: On first startup:
```text ```text
http://localhost:8080/setup 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 ```bash
docker compose logs -f app docker compose logs -f app
``` ```
Stoppen: Stop:
```bash ```bash
docker compose down docker compose down
``` ```
Stoppen und MongoDB-Daten löschen: Stop and delete MongoDB data:
```bash ```bash
docker compose down -v 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 ```yaml
Mongo__ConnectionString: mongodb://mongo:27017 Mongo__ConnectionString: mongodb://mongo:27017
@@ -52,6 +62,6 @@ Mongo__DatabaseName: guestlist
ASPNETCORE_URLS: http://+:8080 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_<timestamp>`. 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_<timestamp>`. After that, the active database is recreated and setup is open again. The latest database backup can be restored from the setup page.