Go to file

Philipp Lang 215d08aeeb continuous-integration/drone/push Build is passing Details continuous-integration/drone/tag Build is passing Details Add setting for seeder		2023-08-07 21:32:56 +02:00
.config/psysh	--wip-- [skip ci]	2022-03-15 16:56:54 +01:00
.docker	Add carddav and caldav redirect	2023-07-25 12:20:58 +02:00
app	Add ResyncAction for Maildispatcher when updating memberships	2023-07-30 11:09:03 +02:00
bin	Add payment management	2021-07-04 16:56:07 +02:00
bootstrap	Initial commit	2020-04-10 20:32:12 +02:00
config	Add config for horizon workers	2023-08-07 19:53:48 +02:00
database	Add setting for seeder	2023-08-07 21:32:56 +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	Add websocket	2023-07-25 17:23:48 +02:00
routes	Fix: Delete local addresses when deleting maildispatcher	2023-06-15 00:08:01 +02:00
storage	Add pdf generator	2021-07-16 00:12:19 +02:00
tests	Lint	2023-08-07 19:52:42 +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	Fix deploy key	2023-07-25 15:35:20 +02:00
.editorconfig	Initial commit	2020-04-10 20:32:12 +02:00
.eslintrc.json	Add eslint	2022-02-12 14:19:00 +01:00
.gitattributes	Initial commit	2020-04-10 20:32:12 +02:00
.gitignore	Merge entrypoints	2023-07-24 17:34:38 +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	Add deployments	2023-07-25 12:21:41 +02:00
README.md	Update install	2023-07-20 22:58:51 +02:00
artisan	Initial commit	2020-04-10 20:32:12 +02:00
composer.json	Add websocket	2023-07-25 17:23:48 +02:00
composer.lock	Add websocket	2023-07-25 17:23:48 +02:00
docker-compose.prod.yml	Add deployments	2023-07-25 12:21:41 +02:00
docker-compose.yml	Add websocket	2023-07-25 17:23:48 +02:00
package-lock.json	Add websocket	2023-07-25 17:23:48 +02:00
package.json	Add websocket	2023-07-25 17:23:48 +02:00
phpstan.neon	Fixed tests	2023-07-24 17:50:05 +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 search params for input	2023-05-08 15:11:16 +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.

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
Automatisches Rechunungssystem
Eigene Beiträge hinterlegen (z.B. interner Stammes-Jahresbeitrag)
Generieren von Zuschusslisten (aktuell RdP NRW)
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 normalerweise nur jede*r einzelne 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

App Key generieren

Kopiere .app.env.example nach .app.env

cp .app.env.example .app.env

Services starten:

docker compose up

Es wird die ein App Key generiert: Keinen APP KEY gefunden. Key wird generiert: base64:..........

Kopiere diesen App key und setze in in .app.env als APP_KEY ein (APP_KEY=base64:........).

Einstellungen

Passe in der .app.env dann folgende Einstellungen an:

APP_URL

Hier sollte die URL (mit HTTPS) stehen, unter der Adrema erreichbar sein soll (z.B. https://adrema.stamm-bipi.de)

Mail

Setze nun die Einstellungen für den Mail-Versand ein. Du solltest mindestens MAIL_PORT, MAIL_HOST, MAIL_USERNAME, MAIL_PASSWORD und MAIL_ENCRYPTION setzen.

MAIL_FROM_NAME ist 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 erreichbar sein sollte (z.B. "vorstand@stamm-bipi.de").

DB Passwort

Setze die beiden letzten Variablen (da wo "secret_db_password" steht) auf ein generiertes sicheres Passwort. Bei beiden Variablen muss der gleiche Wert eingestellt werden (also so wie vorher, nur sicherer :D )

Starten

Führe nun den DB Container aus, um eine erste Version der Datenbank zu erstellen.

docker-compose up db -d

Nun kannst du auf localhost:8000 die App öffnen, einen LB verwenden, den Port mit CLI Optionen ändern, etc.

Beim ersten Starten wird ein Benutzer mit folgenden Zugangsdaten erstellt:

E-Mail-Adresse: admin@example.com
Passwort: admin