From c1dac67d7655a5e82e6f91803a8caa5eff59acb8 Mon Sep 17 00:00:00 2001 From: Marvin Borner Date: Sat, 10 Oct 2020 13:32:08 +0200 Subject: Updated installation instructions --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1592e41..1ab28fe 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ # Abizeugs -These are some tools for our Abitur (2021). They are very poorly written and should never be used by anyone except me. +These are some tools for our Abitur (2021). They are very poorly written and should never be used by anyone except us (RBS TG13). + +## Installation +* Install `nodejs`, `npm`, `redis` and `mariadb`. As the installation instructions vary depending on the platform, please look it up on your own +* Start `redis` and `mariadb` +* Create a `mariadb` database +* Copy `.env.example` to `.env` and edit the file accordingly +* Edit `mottos.txt`, `poll.txt` and `name.csv` (not published due to data protection) +* Run `npm i` +* Start the server with `node app` -- cgit v1.2.3