silva
/
adrema
2
1
Fork 0
Code Issues 23 Pull Requests 1 Projects 1 Releases 106 Wiki Activity
1,830 Commits 17 Branches 147 Tags 22 MiB
PHP 80.3%
Vue 17.3%
TeX 1.6%
TypeScript 0.2%
Blade 0.2%
Other 0.3%
Go to file
philipp lang dafda4883d
continuous-integration/drone/push Build is failing Details
Add later registration backend 		2025-08-14 23:55:50 +02:00
.docker Revert "Compile adrema-form scripts in docker build" 2025-05-06 13:21:21 +02:00
app Add later registration backend 2025-08-14 23:55:50 +02:00
bin Exit 0 when copying db 2025-06-11 18:17:02 +02:00
bootstrap Initial commit 2020-04-10 20:32:12 +02:00
config Lint 2025-06-11 18:14:47 +02:00
database Add leader_conditions to backend 2025-07-09 23:11:10 +02:00
doc Add doc for installation 2023-05-17 02:32:40 +02:00
packages nami mglnr should be a string (Fix #4) 2025-07-09 00:58:39 +02:00
public Remove phpinfo 2022-01-03 01:49:43 +01:00
resources Add tags to form overview 2025-07-16 15:14:46 +02:00
routes Lint 2025-07-09 21:21:23 +02:00
storage Add image component to form 2024-03-17 02:08:13 +01:00
tests Add later registration backend 2025-08-14 23:55:50 +02:00
.ackrc decrease tailwindcss compile time 2021-07-03 23:52:44 +02:00
.app.env.example Add member search via meilisearch 2024-01-28 11:43:43 +01:00
.bash_history --wip-- [skip ci] 2022-03-15 16:56:54 +01:00
.dockerignore Fix meilisearch config 2024-01-28 19:10:31 +01:00
.drone.yml Fix php version of deploy 2024-11-12 01:20:41 +01:00
.editorconfig Initial commit 2020-04-10 20:32:12 +02:00
.gitattributes Initial commit 2020-04-10 20:32:12 +02:00
.gitignore Add Phpunit to gitignore 2024-12-15 11:56:13 +01:00
.gitmodules Add silvaletter template 2024-07-17 23:18:25 +02:00
.prettierrc Add salutation field 2023-02-27 22:40:47 +01:00
.styleci.yml Initial commit 2020-04-10 20:32:12 +02:00
CHANGELOG.md Update CHANGELOG 2025-07-16 15:52:31 +02:00
Envoy.blade.php Mod stammsilva server name 2025-04-01 21:14:00 +02:00
README.md Update README 2025-04-04 00:13:22 +02:00
artisan Initial commit 2020-04-10 20:32:12 +02:00
composer.json Update to inertia 2.0 2025-06-13 13:42:31 +02:00
composer.lock Update to inertia 2.0 2025-06-13 13:42:31 +02:00
docker-compose.prod.yml Remove restart always 2025-04-03 23:07:16 +02:00
docker-compose.yml Remove invoice volume 2024-07-18 01:40:55 +02:00
eslint.config.mjs Update eslint 2025-06-11 17:43:20 +02:00
package-lock.json Add Popup confirm before copying a form 2025-06-17 02:05:42 +02:00
package.json Add Popup confirm before copying a form 2025-06-17 02:05:42 +02:00
phpstan.neon Lint 2025-06-15 21:32:21 +02:00
phpunit.xml Add scout driver config to tests 2025-04-03 00:11:32 +02:00
postcss.config.js add vite config 2023-06-01 11:05:24 +02:00
server.php Initial commit 2020-04-10 20:32:12 +02:00
tailwind.config.js Cleanup 2024-06-28 12:13:08 +02:00
tsconfig.json Add global modules via unplugin-vue-components 2025-06-11 21:27:07 +02:00
vite.config.js Add global modules via unplugin-vue-components 2025-06-11 21:27:07 +02:00
webpack.mix.js Add geolocation for member map 2023-05-16 17:19:56 +02:00

README.md

Adrema

Schön, dass du den Weg hierhin gefunden hast!

Da du diese Seite besuchst, gehörst du sicherlich zu den Leuten, die möglichst einfach die Daten ihrer Mitglieder pfelgen wollen. Das ist offiziell in der DPSG nur mit NaMi möglich.

Die AdReMa (= "AddRessManagement") macht das auch, nur einfacher, schöner und intuitiver als es NaMi tut.

Mitglieder-Übersicht

AdReMa kann von jedem und jeder genutzt werden, die einen NaMi-Account besitzt und Schreibrechte hat (i.d.R. sind das Stammesvorstände, e.V.-Mitglieder und andere, die Mitgliederdaten und deren Abrechungen und Beiträge pflegen müssen).

Was kann ich mit AdReMa machen?

  • Basisdaten von Mitgliedern anzeigen und bearbeiten
  • Einfacher Filter nach Gruppierung, Tätigkeit, etc
  • Detailansichten mit allen zugehörigen Daten
  • Führungszeugnisse und Präventionssulungen nachhalten
  • Beitragszahlungen eintragen
  • Automatische Rechunungserstellung
  • Eigenen Beitragssatz hinterlegen (z.B. interner Stammes-Jahresbeitrag)
  • Generieren von Zuschusslisten (aktuell RdP NRW, Bdkj Hessen, Stadt Solingen, Stadt Remscheid, Stadt Frankfurt a. M.)
  • Einpflegen von internen Tätigkeiten, die nicht in NaMi vorhanden sind (um z.B. stammes-interne AGs / AKs zu verwalten)
  • Automatisches Erstellen und Managen von E-Mail-Verteilern mittels Mailman 3.0
  • eFz-Bescheinigung abrufen für alle Leitenden (das kann in NaMi nur jede*r für sich selbst)
  • Ausbildungen eintragen (WBK-Bausteine)
  • Abrufen von Kontakten ins eigene Telefonbuch (mittels CardDAV)

Ziel dieses Projektes ist es, viele Dinge, die man normalerweise manuell zu tun hat so gut es geht zu automatisieren oder zumindest zu vereinfachen. So kann man sich als Leitende*r / Vorstand auf die wichtigeren Dinge konzentrieren wie Gruppenstunden, Lager, Leiterrunden, etc.

Außerdem ist AdReMa auch problemlos auf Handys und Tablets bedienbar ("mobiles Design")

Installation des Produktivsystems

  1. Verschieben der Docker-Compose

    mv docker-compose.prod.yml docker-compose.yml

  2. Anwenden der Beispiel Environmentvariablen-Datei

    mv .app.env.example .app.env

  3. In der .app.env notwendige Einstellungen vornehmen:

    • APP_URL: Hier sollte die URL (mit HTTPS) stehen, unter der Adrema erreichbar sein soll (z.B. https://adrema.stamm-bipi.de)
    • Mail-Server Einstellungen MAIL_PORT, MAIL_HOST, MAIL_USERNAME, MAIL_PASSWORD und MAIL_ENCRYPTION anpassen
    • MAIL_FROM_NAME: Der Name, der als Absender von E-Mails gesetzt wird (z.B. Stamm Bipi Service)
    • MAIL_FROM_ADDRESS: Die dazu gehörige E-Mail-Adresse, die natürlich für antworten erreichbar sein sollte (z.B. vorstand@stamm-bipi.de)
    • DB_PASSWORD und MYSQL_PASSWORD: Mit dem selben neu erstellten, sicheren Passwort für die Datenbank versehen
    • MEILI_MASTER_KEY Mit einem neu erstellten, sicheren Passwort versehen
    • USER_EMAIL und USER_PASSWORD: Einstellen des standard Adrema Logins

  4. Container zur Gennerierung des App-Key starten

    docker compose up php

    Nach einiger zeit wird ein App-Key generiert:

    Keinen APP KEY gefunden. Key wird generiert: base64:xxx

    Container herunterfahren und entfernen

    docker compose down

  5. Der generierte App-Key muss als Environmentvariable (APP_KEY) mit in den Docker-Container gegeben werden. Kopiere den App-Key in die Datei .app.env

    APP_KEY=base64:xxx

  6. Alle Container starten

    docker compose up -d

  7. Nach kurzer Zeit ist AdReMa über http://localhost:8000 erreichbar und es kann sich mit dem zuvor festgelegten Login eingeloggt werden

Individuelle anpassungen

Rechnungswesen

Bei dem Setup wird im Daten-Verzeichniss ein Ordner ./data/setup angelegt. Hier kann das Logo des Stammes in den Briefkopf eingefügt werden. Zusätzlich kann der Text der Rechnung und der Zahlungserinnerung angepasst werden, dafür ist ein grundlegendes Verständnis für .tex Datein erforderlich.

Nutzen des Entwicklungssystmes

  1. Klonen des Reposetories

    git clone https://git.zoomyboy.de/silva/adrema.git

  2. Kopieren der Beispiel Environmentvariablen-Datei

    cp .app.env.example .app.env

  3. Submodule aktuallisieren

    git submodule update --init

  4. Container erstellen

    docker compose build

  5. Mit Schritt 3 und den folgenden der Installation des Produktivsystems fortfahren