axeleroy/self-host-planning-poker repository overview

⁠Self-host Planning Poker

A hassle-free Planning Poker application to deploy on your NAS.

⁠What is it?

This application is intended as a simplified and self-hostable alternative to Planning Poker Online⁠.

It features:

• Multiple deck types: Fibonacci, modified Fibonacci, T-Shirt sizes, powers of 2 and trust vote (0 to 5)
• Spectator mode
• Responsive layout
• Vote summary
• Translations (English, French, German, Italian and Polish. Contributions welcome!⁠)

It does not have fancy features like issues management, Jira integration or timers.

⁠Screenshots

⁠Deployment

Deploying the application is easy as it's self-contained in a single container. All you need is to create a volume to persist the games settings (ID, name and deck).

⁠Docker

docker run \
  -v planning-poker-data:/data \
  -p 8000:8000 \
  axeleroy/self-host-planning-poker:latest

⁠docker-compose

version: "3"
services:
  planning-poker:
    image: axeleroy/self-host-planning-poker:latest
    ports:
      - 8000:8000
    volumes:
      - planning-poker-data:/data
volumes:
  planning-poker-data: {}

⁠Environment variables

⁠Running behind a reverse-proxy

Refer to Socket.IO's documentation⁠ for setting up your reverse-proxy to work correctly with Socket.IO.

⁠Customization

See Customizing the application's style and icon⁠.

⁠Getting involved

⁠I'm a developer and I want to help

You are welcome to open Pull Requests resolving issues in the Project⁠ or tagged pr-welcome⁠. Don't forget to mention the issue you want to close 😉

⁠I'm a user and I need help / I encountered a bug / I have a feature request

Open an issue⁠ and I'll take a look at it.

⁠I'm a user and want to contribute translations

There is a Crowdin project⁠ that lets you add translations for your language. If your language is not available, feel free to contact me over Crowdin.