From 5b3b5b35e55a6c551a63f36cdf1274953fa7f498 Mon Sep 17 00:00:00 2001 From: cato <47259183+cato447@users.noreply.github.com> Date: Sat, 13 Feb 2021 17:49:20 +0100 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c1aba89..9f6759b 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ All private data got removed
You are free to use this web server
Be aware that this webserver isn't really securly build. To avoid complications use a DNS mask +# Requierments +MySql + # Installation Clone the repo
Run `cd AbizeitungVotingSystem`
@@ -13,11 +16,15 @@ Run `mvn install -DskipTests`
The .jar is located in the target folder
Run the .jar as a deamon on your machine
-Webserver is reachable at host_ip:8000 +Webserver is reachable at host_ip:8000
+(Check if your firewall allows traffic over port 8000 if website is not reachable) # Usage -Add your email whitelist to the file emails.txt -To alternate between adding and voting mode with the two coresponding booleans in the VotingController.java file +Add your email whitelist to the file `AbizeitungVotingSystem/src/main/resources/Email_Whitelist.txt`
+Add your Categories to the file `AbizeitungVotingSystem/src/main/resources/Categories.txt`
+Adjust the regex in `VotingController.java` and `start.html` to suit your needs
+
+To alternate between adding and voting mode with the two coresponding booleans in the `VotingController.java` file # Contribution Feel free to fork the repo and submit a pull-request. I will review and add it happily :)