From 18ae1ce4af26b7fd9dd5735664b595ac3c789450 Mon Sep 17 00:00:00 2001
From: Johannes Theiner <kontakt@joethei.xyz>
Date: Tue, 23 Nov 2021 10:59:00 +0100
Subject: [PATCH] adding readme and automatic builds

---
 .gitignore    |  3 ++-
 README.md     | 40 ++++++++++++++++++++++++++++++++++++++++
 composer.json |  2 +-
 3 files changed, 43 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index 3507b38..55e2f94 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
 .idea
 config.ini.php
-vendor
\ No newline at end of file
+vendor
+*.lock
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c7e9141
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Alumni
+[![Build Status](https://teamcity.joethei.xyz/app/rest/builds/buildType:(id:Studium_Programming_DigiHelfer_Alumni)/statusIcon)](https://teamcity.joethei.xyz/viewType.html?buildTypeId=Studium_Programming_DigiHelfer_Alumni&guest=1)
+
+---
+
+## [Demo](https://test.joethei.de)
+Login zum einsehen der Daten ist unter `login.php` mit den Zugangsdaten `test:test`
+
+## Installation
+
+- eine bereits fertig gebaute Version kann [hier](https://teamcity.joethei.xyz/repository/downloadAll/Studium_Programming_DigiHelfer_Alumni/.lastSuccessful/artifacts.zip) heruntergeladen werden, diese wird einmal wöchentlich automatisch aktualisiert.
+- oder den Quellcode herunterladen und die Abhängigkeiten mit [Composer](https://getcomposer.org/) installieren.
+
+Die dabei erhaltenen Dateien können dann auf einen Webserver hochgeladen werden.
+
+
+## Konfiguration
+
+Die Konfiguration muss vor der ersten Verwendung angepasst werden,
+dazu die entsprechenden Werte in der `config.ini.php.sample` anpassen und in `config.ini.php` umbenennen.
+
+### Datenbank
+zur Speicherung der Daten wird eine MySQl Datenbank verwendet, die Zugangsdaten müssen
+in Konfiguration angegeben werden.
+Zusätzlich müssen die folgenden Tabellen erstellt werden:
+```mysql
+create table entries(id bigint auto_increment primary key, name varchar(255), mail varchar(255),
+                     year int(4), birthday date, verify bool, vocation varchar(255), creation DATE,
+                     location varchar(100), phone varchar(50)
+);
+
+create table verify(id bigint primary key, uuid VARCHAR(36),foreign key verify(id) REFERENCES entries(id));
+
+CREATE TRIGGER before_insert_verify BEFORE INSERT ON verify FOR EACH ROW SET new.uuid = uuid();
+```
+
+### Mail Server
+Der Mail Server wird verwendet um Bestätigungs E-Mails zu versenden und muss angegeben werden.
+
+Der Konfigurationswert `url` wird dabei zu Generierung des Bestätigungslinks verwendet.
\ No newline at end of file
diff --git a/composer.json b/composer.json
index e6975a7..90d6a0c 100644
--- a/composer.json
+++ b/composer.json
@@ -1,7 +1,7 @@
 {
     "require": {
         "phpmailer/phpmailer": "^6.4.1",
-        "rakit/validation": "v1.4.0",
+        "rakit/validation": "^v1.4.0",
         "ext-pdo": "*"
     },
     "name": "digihelfer/alumni",