README.md 2.31 KB
Newer Older
1
<!--@author Adrian Piacek-->
Adrián Piaček's avatar
Adrián Piaček committed
2
3
4
5
6
7
8
9
10
11
12
13
# Online Gaming Management System

## About project
* **Name**: Online Gaming Management System
* **Description**:
The goal of the system is to manage teams of users participating to eSports competitions. The system should allow to track the different team members with their records and statistics depending on different online games. It should also allow to manage the teams and their results in the competitions against other teams. Competitions with other teams can be set in some location together with prizes and score results from all the participants. History of all the results can be seen by the users with the best teams according to different games and statistics.
## Team
- Adrian Piacek @xpiacek
- Dominik Kozubik @xkozubi1
- Marek Kadlecik @xkadlec5
- Matus Valko @xvalko2

14
15
## Building instructions
You can run the Online Gaming Management System with maven:
16
### Milestone 3
17

18
19
20
21
22
23
24
#### Web Application

- start in the root directory `online-gaming-management-system`
- use `mvn clean install` to compile sources
- `cd gaming-spring-mvc` move to the module of the web app
- execute `mvn cargo:run` to start the server
- UI - open `http://localhost:8080/pa165/` in the browser
25
- Use username `poter` and password `admin` to access administrative functionality
26

27
#### REST demo
Marek Kadlečík's avatar
Marek Kadlečík committed
28
We exposed `Player` entity in REST API. Execute `mvn cargo:run` on rest module to run rest api.
29
30
31
32
33
34

Create a new player:
```bash
$ curl -X POST -i -H "Content-Type: application/json" --data '{"killStat":1, "deathStat":2, "assistStat":3}' http://localhost:8080/pa165/rest/players/create
```

35
Find player according to `uuid`:
36
```bash
37
$ curl -X GET http://localhost:8080/pa165/rest/players/9384b466-badf-40ca-bbeb-4d8f6eb98042
38
39
40
41
42
43
44
```

Find all players:
```bash
$ curl -X GET http://localhost:8080/pa165/rest/players
```

45
46
47
48
49
Update player:
```bash
$ curl -X PUT -i -H "Content-Type: application/json" --data '{"killStat":5, "deathStat":6, "assistStat":7}' http://localhost:8080/pa165/rest/players/9384b466-badf-40ca-bbeb-4d8f6eb98042
```

50
51
52
53
54
Delete player:
```bash
$ curl -X DELETE http://localhost:8080/pa165/rest/players/9384b466-badf-40ca-bbeb-4d8f6eb98042
```

Adrián Piaček's avatar
Adrián Piaček committed
55
56
## Diagrams for assignment
### Class diagram
57
![Class diagram for this project](diagrams/UML class diagram.png)
Adrián Piaček's avatar
Adrián Piaček committed
58
59

### Use Case diagram
60
![Class diagram for this project](diagrams/UML Use Case Diagram.png)