From 059f677815b8d1cf20c1bbde81ac6a3a847f3d52 Mon Sep 17 00:00:00 2001 From: James Ketrenos Date: Sun, 2 Jan 2022 21:43:25 -0800 Subject: [PATCH] Adding documentation Signed-off-by: James Ketrenos --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0749cb4..758ee98 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,38 @@ ### Native +#### Prerequisites + ```bash -sudo apt-get install nodejs npm +sudo apt-get install -y nodejs npm python sudo -E npm install --global npm@latest ``` ### In container ```bash +``` +# Architecture + +```plantuml +skinparam componentStyle rectangle + +component "Server" as server +component "Resources" as res +component "Client" as client +component "Game" as game +component "Player" as player + +package "Game" as game { + component Players as players +} + +server <-> resource : serves to client +client <-> server +player <-> client +players -r-> player +server -> game ``` # Ketr.Ketran REST API @@ -43,8 +66,12 @@ sudo -E npm install --global npm@latest ```bash git clone git.ketrenos.com:jketreno/peddlers-of-ketran.git +npm install cd server npm install +cd .. +npm run-script build +npm run-script backend ``` ## Install