Commit 39afab4e authored by Dennis Willers's avatar Dennis Willers 🏀

Update README.md

parent f5c4ffae
Pipeline #442 passed with stages
in 2 minutes and 52 seconds
...@@ -4,7 +4,9 @@ ...@@ -4,7 +4,9 @@
The project is the backend for the Openplanet Voting plugin on Trackmania. This stand is still in the early stages. With the plugin a player can give a rating to the currently driven map, see the average rating score and see how many players have voted for the track in total. The project is the backend for the Openplanet Voting plugin on Trackmania. This stand is still in the early stages. With the plugin a player can give a rating to the currently driven map, see the average rating score and see how many players have voted for the track in total.
## Technical description ## Technical description
The client can connect to the socket server via `willers.digital` on port `3201`. After the first JSON request from the client the passed mapId is mapped on the client. All clients that are also mapped to the map will get all vote changes. The socket server communicates with the express REST server, which in turn communicates with the MySQL database. The socket server can tell from the request which REST service to invoke, so the client does not communicate directly with the REST service. Assuming the JSON request was submitted correctly The client can connect to the socket server via `willers.digital` on port `3201`. After the first JSON request from the client the passed mapId is mapped on the client. All clients that are also mapped to the map will get all vote changes. The socket server communicates with the express REST server, which in turn communicates with the MySQL database. The socket server can tell from the request which REST service to invoke, so the client does not communicate directly with the REST service. Assuming the JSON request was submitted correctly.
If you just want to call the REST-Server you can do it with: `https://tm-voting.willers.digital`.
## REST Services ## REST Services
There are currently only two REST interfaces. There are currently only two REST interfaces.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment