Adding documentation
Signed-off-by: James Ketrenos <james_eikona@ketrenos.com>
This commit is contained in:
parent
77e550917e
commit
059f677815
29
README.md
29
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
|
||||
|
Loading…
x
Reference in New Issue
Block a user