diff --git a/README.md b/README.md index 78fe4c3..561d5f9 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# member-administration-ui +# FF Admin -Mitgliederverwaltung für Feuerwehren und Vereine. +Administration für Feuerwehren und Vereine. ## Einleitung -Dieses Repository dient zur Verwaltung der Mitgliederdaten. Es ist ein Frontend-Client, der auf die Daten des [member-administration-server Backends](https://forgejo.jk-effects.cloud/Ehrenamt/member-administration-server) zugreift. Die Webapp bietet eine Möglichkeit Mitgliederdaten zu verwalten, Protokolle zu schreiben und Kaledereinträge zu erstellen. Benutzer können eingeladen und Rollen zugewiesen werden. +Dieses Repository dient hauptsächlich zur Verwaltung der Mitgliederdaten, aber auch zur Verwaltung weiterer Daten der Feuerwehr oder eines Vereins. Es ist ein Frontend-Client, der auf die Daten des [ff-admin-server Backends](https://forgejo.jk-effects.cloud/Ehrenamt/ff-admin-server) zugreift. Die Webapp bietet eine Möglichkeit Mitgliederdaten zu verwalten, Protokolle zu schreiben und Kaledereinträge zu erstellen. Benutzer können eingeladen und Rollen zugewiesen werden. Eine Demo dieser Seite finden Sie unter [https://ff-admin-demo.jk-effects.cloud](https://ff-admin-demo.jk-effects.cloud). @@ -25,8 +25,8 @@ Um den Container hochzufahren, erstellen Sie eine `docker-compose.yml` Datei mit version: "3" services: - ff-member-administration-app: - image: docker.registry.jk-effects.cloud/ehrenamt/member-administration/app:latest + ff-admin-app: + image: docker.registry.jk-effects.cloud/ehrenamt/ff-admin/app:latest container_name: ff_member_administration_ui restart: unless-stopped @@ -50,8 +50,8 @@ docker-compose up -d Klonen Sie dieses Repository und installieren Sie die Abhängigkeiten: ```sh -git clone https://forgejo.jk-effects.cloud/Ehrenamt/member-administration-ui.git -cd member-administration-ui +git clone https://forgejo.jk-effects.cloud/Ehrenamt/ff-admin.git +cd ff-admin npm install npm run build npm run start @@ -63,7 +63,7 @@ Ein eigenes favicon und Logo kann über ein volume ausgetauscht werden. ## Einrichtung -1. **Admin Benutzer erstellen**: Erstellen Sie einen Admin Benutzer unter dem Pfad [/setup](https://ff-admin-demo.jk-effects.cloud/setup), um auf die Migliederverwaltung Zugriff zu erhalten. Nach der Erstellung des ersten Benutzers wird der Pfad automatisch geblockt. +1. **Admin Benutzer erstellen**: Erstellen Sie einen Admin Benutzer unter dem Pfad /setup, um auf die Migliederverwaltung Zugriff zu erhalten. Nach der Erstellung des ersten Benutzers wird der Pfad automatisch geblockt. 2. **Rollen und Berechtigungen**: Unter `Benutzer > Rollen` können die Rollen und Berechtigungen für die Benutzer erstellt und angepasst werden.