https://github.com/oknozor/spark-atelier-leaderboard

https://github.com/oknozor/spark-atelier-leaderboard

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/oknozor/spark-atelier-leaderboard
• Owner: oknozor
• Created: 2019-11-06T13:48:08.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T02:31:31.000Z (almost 2 years ago)
• Last Synced: 2024-10-12T23:08:40.858Z (about 1 month ago)
• Language: Java
• Size: 7.96 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 25
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Spark Atelier Leaderboard

## Run

#### Dependency

Before getting started you need to setup [this project](https://github.com/oknozor/caffe_clope_kafka)

#### Backend

- `git clone ...`

- `cd spark-atelier-leaderboard/back`

- `vertx run vertx run src/main/java/org/univ/sparktp/dashboard/MainVerticle.java`

#### Frontend

- `cd ../front`

- `npm install`

- `npm start`

## Note 

Each team start with a zero score. There are only two actions mutating the 

State off the app : creating a team, add completing a step. 

On step completion a team earns 50 points. Steps have no identifier, either you go forward and earn 50 points or nothing happen.

## Endpoints 

- `POST /teams`:

    - body : `{ "name": "Les Daniels" }`

- `GET /teams`: Get all teams

- `POST /teams/{id}/stepCompleted`: earn points for completing a step

- `POST /teams/{id}/stepFailed`: Shame the team for failing the current step

## Model 

#### Team

```

{

 "id": 1, 

 "name": "Les patricks",

 "score" : 0

}

```

#### Streams

![](./docs/stream_diagram.png)

### Todo: 

1. Add database persistence so we can restore the state of the ongoing session in case of crash. 

2. Add a shamefull message on step failure 

3. Design the cli