poker

module
v1.2.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 6, 2023 License: MIT

README

poker

Go release Go Report Card codecov Maintainability Go Reference

Game description

poker is a planning poker game (or scrum poker) limiting vote influence between the players. The goals are to collect an independent vote from each player and to improve the vote experience of distributed teams.

  • Vote progress is shared without showing vote values to avoid influence between players.
  • Vote values are revealed only when the vote session is closed, and the vote distribution is displayed.
  • Players can join or leave at any time.

Early version in console: short demo

Install

The most common usage is to deploy:

  • deploy a container for one poker room on server side,
  • use a modern browser on client side to join the room for the game.
Standard deployment
  • Server using default HTTP port 8081:
docker run -p 8081:8081 -td ghcr.io/fc92/poker:main
  • Browser URL to connect as player Mary: http://server_ip:8081/?arg=-name&arg=Mary
Custom HTTP port deployment

The port can be modified, to add a second poker room for example:

  • Server using non default HTTP port 8083 and room name "TeamOne":
docker run -p 8083:8083 -td ghcr.io/fc92/poker:main ./clients.sh 8083 TeamOne
  • Browser URL to connect as player Mary: http://server_ip:8083/?arg=-name&arg=Mary
Multi room in a Kubernetes namespace (Advanced)

This deployment method adds the possibility for different team to use a dedicated poker room.

Each player connects to a groom program to:

  • choose an existing poker room already deployed,
  • or add a new room.

A Helm chart is provided in the deployments/poker directory.

Prerequisite: namespace accessible with ingress to allow incoming HTTP/HTTPS traffic.

Directories

Path Synopsis
cmd
groom
groom allows to add or remove poker rooms.
groom allows to add or remove poker rooms.
internal
common/logger
logger shared between files of the package groom
logger shared between files of the package groom
groom
package groom is used to add or remove poker room in the context of helm deployment with .Values.rooms
package groom is used to add or remove poker room in the context of helm deployment with .Values.rooms

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL