aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarvin Borner2020-10-10 13:32:08 +0200
committerMarvin Borner2020-10-10 13:32:08 +0200
commitc1dac67d7655a5e82e6f91803a8caa5eff59acb8 (patch)
tree4b4ca09c65b6eb2559148ca26936c442069673a0
parent0e57580efcce8e8f11d5e9643700e706a193f920 (diff)
Updated installation instructions
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
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`