Commit 0063ec94 authored by abergavenny's avatar abergavenny
Browse files

Updated Readme

parent 628e5bf2
# 3% Plus Server
# 3% Plus Tool
![alt_text](https://transfer.hft-stuttgart.de/gitlab/3_percent_plus/ap4_2/-/blob/release-v1.0.0/client/images/desktop.png)
## .env
```
......@@ -11,4 +13,35 @@ MAIL_HOST=
MAIL_PORT=
MAIL_USER=
MAIL_PASS=
```
\ No newline at end of file
```
DATABASE_NAME, DATABASE_USER, DATABASE_PASS müssen identisch mit den Werten der ***./db/init-mongo.js*** Datei sein.
## Information
Es befinden sich Kommentare zur Beschreibung im Code, einfach nach DEVINFO suchen.
Die REST API besitzt einen Endpoint der das CS-T Nutzt, hier kann eine Simulation über das 3% Plus Tool ausgeführt werden. Die Ergebnise werden in der MongoDB gespeichern und sind ebenfalls über die REST API abrufbar.
Für die Nutzung der "Passwort vergessen" und "E-Mail-Bestätigung" Funktionen muss ein entsprechender Mailserver bwz. Zugangsdaten verfügbar sein.
Die Funktion zur E-Mail-Bestätigung kann über die ENV-Variable EMAIL_VERIFICATION=on|off ein- oder ausgeschaltet werden. Dies gilt nicht für die "Passwort vergessen" Funktion, diese ist dauerhaft aktiv.
Die ENV-Variable DB_HOST muss den Namen des MongoDB Containers verwernden. (Default v1.0.0: database)
## Docker Container erstellen
Zuerst muss ein BUILD des Clients erfolgen, hierfür einfach die Befehle in Folge ausführen. (im Ordner ***./client***)
```
npm install
```
```
npm run build
```
Dann kann können die Container mittels Docker Compose (***v2***) erzeugt und gestartet werden.
```
docker compose up -d [--build]
```
Um die Container zu stopppen den Befehl folgenden ausführen
```
docker compose down [-v]
```
> - -d Als Daemon starten
> - --build Neuen Build der Container erzeugen
> - -v Volumes mit entfernen (***Vorsicht!*** Datenbank Volume wird hier ebenfalls gelöscht)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment