summaryrefslogtreecommitdiff
path: root/README.md
blob: 675df662372476d0d45f8d34bdf838db423a46a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# Seven Wonders Online

[![Travis Build](https://img.shields.io/travis/joffrey-bion/seven-wonders/master.svg)](https://travis-ci.org/joffrey-bion/seven-wonders)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/joffrey-bion/seven-wonders/blob/master/LICENSE)

A digital version of the famous [7 Wonders board game](https://en.wikipedia.org/wiki/7_Wonders_(board_game)).

## Work in progress

A very early (staging) version of the app is running [on heroku](https://seven-wonders-online.herokuapp.com/).
It is of course still under development and not usable yet because the development of the client just started.
Also, it is very unstable as it is a staging server where the app is redeployed after every successful build of the 
master branch.
 
### Server

The websocket server API handles most of the game steps:
- Define your username
- Create / Join a game
- View joined lobby
- Start game
- View your hand and the table
- Make moves / See other's moves

Missing steps:
- End of game event
- Access scoring

A [live API documentation using JsonDoc](https://seven-wonders-online.herokuapp.com/livedoc-ui.html?url=https://seven-wonders-online.herokuapp.com/jsondoc)
is available. It is in construction as well because I'm adding wesocket support to the existing REST-API support. 

### Client

The client is just at the start of the development. It handles:
- Username choice
- Create / Join a game
- View joined lobby
- Start game

Missing steps:
- View game elements
- Whole game process
- Scoring

## Disclaimer

We do not own the rights on the 7 Wonders game concept and rules, nor on the assets used here.
bgstack15