silva
/
adrema
2
1
Fork 0
Code Issues 23 Pull Requests 1 Projects 1 Releases 104 Wiki Activity
1,568 Commits 12 Branches 131 Tags 24 MiB
PHP 79.7%
Vue 18.1%
TeX 1.7%
Blade 0.2%
Shell 0.2%
Other 0.1%
Go to file
philipp lang 02684502f1
continuous-integration/drone/push Build is failing Details
Fix tests 		2024-08-31 22:10:59 +02:00
.docker Update base 2024-07-24 22:26:52 +02:00
app Remove edit route from searchable array 2024-08-31 22:10:04 +02:00
bin Add Excel export for participants 2024-07-23 22:59:23 +02:00
bootstrap Initial commit 2020-04-10 20:32:12 +02:00
config Fix: Cast Data object from Settings 2024-07-04 22:29:29 +02:00
database Lint migrations 2024-08-23 22:25:25 +02:00
doc Add doc for installation 2023-05-17 02:32:40 +02:00
packages Add Excel export for participants 2024-07-23 22:59:23 +02:00
public Remove phpinfo 2022-01-03 01:49:43 +01:00
resources Lint 2024-08-28 21:02:53 +02:00
routes Remove member create and edit routes 2024-08-31 22:10:02 +02:00
storage Add image component to form 2024-03-17 02:08:13 +01:00
tests Fix tests 2024-08-31 22:10:59 +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 Clear node_modules in drone 2024-07-18 01:41:12 +02:00
.editorconfig Initial commit 2020-04-10 20:32:12 +02:00
.eslintrc.json Eslint: ignore multi word component rule 2023-08-20 23:35:57 +02:00
.gitattributes Initial commit 2020-04-10 20:32:12 +02:00
.gitignore Add fileshare storage 2024-06-28 15:51:40 +02: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 2024-08-30 22:38:04 +02:00
Envoy.blade.php Fix deploy 2023-08-25 01:12:44 +02:00
README.md Update README 2024-07-17 22:45:16 +02:00
artisan Initial commit 2020-04-10 20:32:12 +02:00
composer.json Add table export 2024-06-30 23:36:44 +02:00
composer.lock Composer update 2024-07-04 23:38:38 +02:00
docker-compose.prod.yml Add compose invoice dir 2024-07-17 23:29:00 +02:00
docker-compose.yml Remove invoice volume 2024-07-18 01:40:55 +02:00
package-lock.json Cleanup 2024-06-28 12:13:08 +02:00
package.json Cleanup 2024-06-28 12:13:08 +02:00
phpstan.neon Lint 2024-07-08 23:17:14 +02:00
phpunit.xml Add fileshare storage 2024-06-28 15:51:40 +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
vite.config.js Add form builder 2024-03-17 02:08:12 +01: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. Herunterladen der Beispiel Docker-Compose

    curl https://git.zoomyboy.de/silva/adrema/raw/branch/master/docker-compose.prod.yml -o docker-compose.yml

  2. Herunterladen der Beispiel Environmentvariablen-Datei

    curl https://git.zoomyboy.de/silva/adrema/raw/branch/master/.app.env.example -o .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 sicheren Passwort für die Datenbank 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 Docker-Compose für das Entwickeln und nach Wünschen anpassen

    cp docker-compose.dev.yml docker-compose.yml

  3. Kopieren der Beispiel Environmentvariablen-Datei

    cp .app.env.example .app.env

  4. Submodule aktuallisieren

    git submodule update --init

  5. Container erstellen

    docker compose build

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