Über das MitarbeiterBoard

Das MitarbeiterBoard ist ein Freizeitprojekt, welches entstanden ist um die Kommunikation innerhalb des Evangelischen Schulzentrums zu unterstützen. Es ermöglicht die Vorbereitung von Dienstberatungen online, in dem Themen durch Leitungen und Mitarbeiter im vorraus benannt, terminiert und priorisiert werden. Die Protokolle der besprochenen Themen werden direkt zu dem Thema abgelegt und sind somit jederzeit direkt abruf- und nachverfolgbar. Es basiert auf dem Laravel-Framework.

Nutzung

Obwohl das MitarbeiterBoard ausschließlich für das Evangelische Schulzentrum Radebeul gedacht war, kann die Software frei für nicht-kommerzielle Projekte im Bereich der Bildung genutzt werden. Es gibt jedoch keinerlei Anspruch auf Support oder Haftung, sollten Schäden oder Probleme auftreten. Änderungen und Weiterentwicklungen sind ebenfalls als Open-Source zur Verfügung zu stellen.

Systemvoraussetzungen

• PHP 7.4
• Composer 2

Installation

Nach dem Upload der Dateien auf den Server ist zunächst die Datei ".env.example" in ".env" umzubenennen und auszufüllen. Entscheidend sind dabei die Eintragungen zu Datenbank und Mail-Server.

cp .env.example .env

Die Datei per Texteditor öffnen und mindestens folgende Daten ausfüllen:

APP_NAME=

APP_LOGO=

APP_ENV=production

APP_DEBUG=false

APP_URL=

DB_CONNECTION=mysql

DB_HOST=127.0.0.1

DB_PORT=3306

DB_DATABASE=laravel

DB_USERNAME=root

DB_PASSWORD=

MAIL_MAILER=smtp

MAIL_HOST=

MAIL_PORT=

MAIL_USERNAME=

MAIL_PASSWORD=

MAIL_ENCRYPTION=

MAIL_FROM_ADDRESS=

MAIL_FROM_NAME=

Anschließend die Installation durchführen:

composer install

php artisan key:generate

php artisan webpush:vapid

php artisan migrate

Während dem Erstellen der Datenbanktabellen wird ein erster Benutzer mit der in der .env-Datei angegebenen E-Mail erstellt. Als Kennwort dient das aktuelle Datum 8-stellig. Es muss mit dem ersten Login geändert werden.

Nun muss noch der CronJob angelegt werden, damit die automatisierten Prozesse für Benachrichtigungen und Mail-Versan laufen:

crontab -e

und dort eintragen:

* * * * * cd /your-project-path && php artisan schedule:run >> /dev/null 2>&1

Run with docker

To run the app in docker, simply

docker-compose up

First time setup

When running for the first time, copy example.env to .env. That file is usable as is for a test setup. Then run the artisan commands

docker-compose exec app php artisan key:generate
docker-compose exec app php artisan webpush:vapid
docker-compose exec app php artisan migrate

In case the last command fails because you forgot something, for instance some email, then rollback with

docker-compose exec app php artisan migrate:rollback

correct the configuration and migrate again.

To create the very first user, you user tinker:

docker-compose exec app php artisan tinker

Then:

$user = new App\Models\User();
$user->password = Hash::make('1234');
$user->name = 'max';
$user->email = '[email protected]
$user->save();';

and exit by typing ctrl+d

Now go to localhost in your browser and use the credentials just created.

Since the database is persistent, at the next docker-compose up, there is no need to migrate or create a user again.

To reset the database when developing, just remove the corresponding docker volume:

docker volume rm mitarbeiterboard_dbdata