From e3309404337b7e0fe501eb3c77a987fe785c7df8 Mon Sep 17 00:00:00 2001 From: Kayne Ruse Date: Fri, 19 Mar 2021 20:06:48 +1100 Subject: [PATCH] Created microservices (markdown) --- microservices.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 microservices.md diff --git a/microservices.md b/microservices.md new file mode 100644 index 0000000..3866b63 --- /dev/null +++ b/microservices.md @@ -0,0 +1,22 @@ +# Microservices + +This project uses the [microservice architecture](https://en.wikipedia.org/wiki/Microservices). + +Currently, there are three officially supported microservices: + +* News Server: https://github.com/krgamestudios/news-server +* Auth Server: https://github.com/krgamestudios/auth-server +* Chat Server: https://github.com/krgamestudios/chat-server + +## News-Server + +The news server is the first and most stable element of this system. It provides a stream of news articles, as well as features to publish, edit and delete them. It relies on the auth-server's tokens for authentication. + +## Auth-Server + +The auth-server is probably the only required microservice. It provides the signup, login and account systems. It does this via JSON web tokens (JWTs), which are needed for all authorized features of the other microservices. + +## Chat-Server + +The chat server provides game-wide room-based chat between users. It requires a valid tokens from the auth-server, otherwise it works pretty simply - it records the chat between all rooms. +