Merge pull request #22 from H4CK3R-01/update_readme

Updated README.md
This commit is contained in:
H4CK3R-01 2021-06-11 09:25:04 +02:00 committed by GitHub
commit c19d09d6d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,31 +1,46 @@
# Projektmanagement Game # Projektmanagement Game
## Docker ## Docker
### Build ### Build
``` ```
docker build Projektmanagement-Game/ -t pm-game docker build Projektmanagement-Game/ -t pm-game
``` ```
### Deploy ### Deploy
``` ```
docker run -d -p 80:5000 pm-game docker run -d -p 80:5000 pm-game
``` ```
### Check if it works ### Check if it works
Open `http://127.0.0.1` in your Browser Open `http://127.0.0.1` in your Browser
## Without docker ## Without docker
### Install dependencies
```
npm install
```
### (Optional) Use crendentials for monitoring
Set environment variables `WEBSOCKET_MONITOR_USERNAME` and `WEBSOCKET_MONITOR_PASSWORD`
`WEBSOCKET_MONITOR_USERNAME`: Username
`WEBSOCKET_MONITOR_PASDSWORD`: bcrypt hashed password. Generate with
```
node
> require("bcrypt").hashSync("<your-password>", 10)
```
Linux & MacOS: `export NAME="VALUE"`
Windows: `set NAME="VALUE"`
### Run ### Run
``` ```
node Webservice/server.js node Webservice/server.js
``` ```
### Check if it works ### Check if it works
Open `http://127.0.0.1:5000` in your Browser Open `http://127.0.0.1:5000` in your Browser