trinitything / bingo

Simple Game

Bingo

About

Bingo is a simple app for tracking a simplified corpo-bingo-styled game where players are assigned daily quests for certain work-related phrases. The player marks the number of times the phrase was spoken that day and receives an equivalent in points.

This application provides both a frontend page for displaying each player's phrase and total points, as well as a set of REST endpoints for outside interactions.

Setup

Hook up draw_app.app:app as the WSGI endpoint in your HTTP server of choice.

See https://flask.palletsprojects.com/en/1.1.x/deploying/#deployment for reference.

Front-end

A simple front-end is available at /draw/ and redirected to from base URL (/).

REST API endpoints

$ GET /draw/api/daily

Description

Returns a list of today's assignments.

Example response

{
  "Player1": "Phrase1",
  "Player2": "Phrase2",
  "Player3": "Phrase3"
}

$ GET /draw/api/players/<player:string>/points

Description

Returns the current score of the given player.

Example response

{
  "Player1": 0
}

$ POST /draw/api/players/<player:string>/points

Description

Allows modifying a given player's score. Returns the player's score after the modification.

Arguments

• "action" (string)

action	result
"add"	Increments the player's score
"reset"	Resets the player's score to zero

Example:

curl -X POST -d '{"action": "add"}' <app>/draw/api/players/Player1/points

Example response

{
  "Player1": 1
}

bingo's Issues

Inconsistency between config and database

The latest configuration method isn't properly enforced in the database on deploy:

Before the config we had a player named "Śto", now config file defines him as "Sito", and both entries are present in the database.

We need to provide a way of enforcing the names in the configuration, e.g. by scratching the database on deploy if names are different.

Make REST API for points more canonical

@app.route('/draw/rest/addPoints', methods=['POST'])

This version is very non-standard, usually rest APIs are more like:
/draw/rest/points
with GET and POST/PUT for reading and manipulating respectively

Make player names and options user-configurable

Use e.g. the configparser module to read a simple INI file with a list of player names and options.

Add history database in backend. Use Pony.

Add README.md

Configure Github Actions CI for tests

Add possibility to change name of user. Field in database should be changed as well

Add frontend for adding points

Add db backend

Organize deploy

We could assign a special branch for deploys on Heroku.

Right now master is our point of sync, so maybe create a 'deploy' branch, to which we merge/rebase once we have a coherent set of changes/fixes that can be published on the server.

Add tests for draw_app

Add frontend view for the daily draw

Make frontend scalable. Resizing shall not impacts on readability

Implement point storage

Find bottlenecks and create for them separate issues.

Refreshing points takes more than one second.
Optimization might be faked by frontend. e.g. Predicting value of increments without waiting for the response. -> if we receive info error info, change back the value.

Add frontend for draw history

Add possibility to dynamically add/remove new player. New EndPoint