Code Monkey home page Code Monkey logo

full-house's Introduction

Full House

CircleCI Docker Image Version (latest semver)

This is a simple software implementation of a Planning Poker game, mostly used in agile software development.

Players can join a game while e.g. being in a refinement meeting and use this game to estimate the issues discussed in the meeting.

Run with Docker

Full House can be easily run with Docker:

docker run -p 8080:8080 philmtd/full-house

Install in Kubernetes with Helm

The Full House Helm chart is available in the following chart repo:

helm repo add philmtd https://philmtd.github.io/helm-charts

Configuration

Full House runs perfectly fine with the default configuration.

Customising voting schemes

It is possible to adjust the available voting schemes from which the users can choose when creating a new game. Per default there are the following two schemes available:

fullHouse:
  votingSchemes:
    - name: Fibonacci
      scheme: [0, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
      includesQuestionmark: true
    - name: Extended Fibonacci
      scheme: [0, 0.25, 0.5, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
      includesQuestionmark: true

If you want your own custom voting schemes you need to place your configuration in a fullhouse.yaml in the config sub-directory of the Full House installation directory.

Each scheme needs a name, the numbers available to vote (need to be 0 or greater, can be floating point numbers) and you can define whether to include a questionmark ? voting card or not. If you use a custom config the defaults will be overwritten, so if you want to include the default schemes just copy them into your configuration.

Persistence

Full House does not persist any data. All the state is kept in memory.

This has some theoretical downsides:

  • Restarting the application will wipe all currently running games and the players will have to create a new game.
  • As memory is unique to the application, Full House cannot be scaled horizontally.

Practically these should not appear as problems at the scale this app is intended for.

Screenshots

The UI has light and dark modes:

Voting Results
Voting in light mode Results in light mode
Voting in light mode Results in dark mode

full-house's People

Contributors

philmtd avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.