jketreno/peddlers-of-ketran
1
0
Fork 0
Code Issues 42 Activity

Update README

Browse Source 
Signed-off-by: James Ketrenos <james_eikona@ketrenos.com>
This commit is contained in:
James Ketrenos 2021-12-31 16:47:09 -08:00
parent f8b2ea333e
commit da28abdb0a
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,10 +1,20 @@
# Ketr Settlers # Peddlers of Ketran
## Building
### Native
```bash ```bash
sudo apt-get install nodejs npm sudo apt-get install nodejs npm
sudo -E npm install --global npm@latest sudo -E npm install --global npm@latest
``` ```
### In container
```bash
```
# Ketr.Ketran REST API # Ketr.Ketran REST API
## POST /api/v1/game ## POST /api/v1/game
@ -13,7 +23,7 @@ sudo -E npm install --global npm@latest
```json ```json
{} {}
```` ```
### Response ### Response
@ -29,10 +39,10 @@ sudo -E npm install --global npm@latest
# Configuring / installing # Configuring / installing
## Build ## Build
```bash ```bash
git clone ... git clone git.ketrenos.com:jketreno/peddlers-of-ketran.git
cd server cd server
npm install npm install
``` ```
@ -75,6 +85,7 @@ EOF
``` ```
## Launch ## Launch
```bash ```bash
sudo systemctl start ketr.ketran sudo systemctl start ketr.ketran
``` ```
@ -87,6 +98,7 @@ curl -k -s -X POST http://localhost:8911/ketr.ketran/api/v1/games/
``` ```
### Game status ### Game status
```bash ```bash
curl -k -s -X GET http://localhost:8911/ketr.ketran/api/v1/games/:id curl -k -s -X GET http://localhost:8911/ketr.ketran/api/v1/games/:id
``` ```