chris/kerstezel-ober
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Chris Josten 2020-12-28 21:30:04 +01:00
parent 36701a8c93
commit a8bd8f8428
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# Kerstezel Server
This is the server component of the Kerstezel project. This renders the public webpage and forwards
the drum commands from our beloved users towards the Santa of IAPC.
## Building (normal)
1. Install dmd and dub from your distro's package manager (or for those unlucky enough to live without
a package managers: https://dlang.org/download.html)
2. Make sure openssl development libraries are installed.
3. Run `dub build`. This will automatically download other dependencies and compile them.
## Building (nix)
1. `nix build .`
## Running
1. Run the produced `kerstezel` binary. Note that the built-in file webserver expects to have
the `statisch` folder in its working directory. It will listen on port 8090 for http-requests and
on port 9305 for the kerstezel-client.. If you want to change any of this, edit the program and
recompile.