Go to file
philipp lang 41d6a71d2f
continuous-integration/drone/push Build is failing Details
Fix rawurldecode
2023-10-30 22:58:25 +01:00
.config/psysh --wip-- [skip ci] 2022-03-15 16:56:54 +01:00
.docker Add memory_limit for schedule 2023-08-21 14:15:29 +02:00
app Fix rawurldecode 2023-10-30 22:58:25 +01:00
bin use docker container for copydb 2023-10-18 16:52:30 +02:00
bootstrap Initial commit 2020-04-10 20:32:12 +02:00
config Add Plugin manager 2023-09-19 00:13:36 +02:00
database Lint 2023-09-19 20:14:52 +02:00
doc Add doc for installation 2023-05-17 02:32:40 +02:00
packages Update silvaletter 2023-07-18 11:24:52 +02:00
public Remove phpinfo 2022-01-03 01:49:43 +01:00
resources Fix: Allow umlauts in Contribution generator 2023-10-27 00:48:50 +02:00
routes Update course actions 2023-10-18 16:52:30 +02:00
storage Add pdf generator 2021-07-16 00:12:19 +02:00
tests Fix: Allow umlauts in Contribution generator 2023-10-27 00:48:50 +02:00
.ackrc decrease tailwindcss compile time 2021-07-03 23:52:44 +02:00
.app.env.example Add setting for seeder 2023-08-07 21:32:56 +02:00
.bash_history --wip-- [skip ci] 2022-03-15 16:56:54 +01:00
.dockerignore ignore log file 2023-08-07 20:14:32 +02:00
.drone.yml set memory limit for php container 2023-10-18 18:30:18 +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 Update .gitignore and change cookies volumes 2023-09-05 16:42:39 +02:00
.gitmodules mod gitmodules 2023-05-08 15:56:16 +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
Envoy.blade.php Fix deploy 2023-08-25 01:12:44 +02:00
README.md Update README 2023-09-12 12:19:10 +02:00
artisan Initial commit 2020-04-10 20:32:12 +02:00
composer.json Add Plugin manager 2023-09-19 00:13:36 +02:00
composer.lock Add Plugin manager 2023-09-19 00:13:36 +02:00
docker-compose.prod.yml Add Host-ENV for nginx webservice 2023-09-07 14:40:31 +02:00
docker-compose.yml Add Plugin manager 2023-09-19 00:13:36 +02:00
package-lock.json Add eslint prettier 2023-08-10 16:33:36 +02:00
package.json Add eslint prettier 2023-08-10 16:33:36 +02:00
phpstan.neon Lint 2023-10-18 18:14:07 +02:00
phpunit.xml Add websocket 2023-07-25 17:23:48 +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 Add composable dir to tailwind content 2023-08-20 23:36:38 +02:00
vite.config.js Update to vue 3 2023-07-06 13:56:19 +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. 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

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