cato447/AbizeitungVotingSystem
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
cato
2021-02-13 17:49:20 +01:00
committed by GitHub
parent a49725cdd6
commit 5b3b5b35e5
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -4,6 +4,9 @@ All private data got removed <br>
You are free to use this web server <br> You are free to use this web server <br>
Be aware that this webserver isn't really securly build. To avoid complications use a DNS mask Be aware that this webserver isn't really securly build. To avoid complications use a DNS mask
# Requierments
MySql
# Installation # Installation
Clone the repo <br> Clone the repo <br>
Run `cd AbizeitungVotingSystem` <br> Run `cd AbizeitungVotingSystem` <br>
@@ -13,11 +16,15 @@ Run `mvn install -DskipTests`<br>
The .jar is located in the target folder<br> The .jar is located in the target folder<br>
Run the .jar as a deamon on your machine <br> Run the .jar as a deamon on your machine <br>
Webserver is reachable at host_ip:8000 Webserver is reachable at host_ip:8000 <br>
(Check if your firewall allows traffic over port 8000 if website is not reachable)
# Usage # Usage
Add your email whitelist to the file emails.txt Add your email whitelist to the file `AbizeitungVotingSystem/src/main/resources/Email_Whitelist.txt` <br>
To alternate between adding and voting mode with the two coresponding booleans in the VotingController.java file Add your Categories to the file `AbizeitungVotingSystem/src/main/resources/Categories.txt` <br>
Adjust the regex in `VotingController.java` and `start.html` to suit your needs <br>
<br>
To alternate between adding and voting mode with the two coresponding booleans in the `VotingController.java` file
# Contribution # Contribution
Feel free to fork the repo and submit a pull-request. I will review and add it happily :) Feel free to fork the repo and submit a pull-request. I will review and add it happily :)