Skip to content

qwikens/planning-poker

Repository files navigation

Planning Poker

MIT License GitHub Repo stars

Planning poker (also called Scrum poker) helps agile teams estimate the time and effort needed to complete each initiative on their product backlog. The name from this gamified technique is planning poker because participants use physical cards. These cards, which look like playing cards, estimate the number of story points for each backlog story or task up for discussion.

https://www.productplan.com/glossary/planning-poker/

How to play

Open the planning poker game for free and start a new game;

image

Input the game basic information and create your user name;

image

Create the issues and invite your team members! πŸš€πŸš€πŸš€

image

Don't worry about the security of your data, all the issues are E2E encrypted. Check out the implementation overview: https://dev.to/qwikens/implementing-end-to-end-encryption-e2ee-to-a-planning-poker-game-1hoi

Demo

Planning Poker demo at @scalar town hall. ✨

Screenshot from 2024-05-13 14-42-39

Tech Stack

Client: React, Vite, TypeScript, Valtio, TailwindCSS, Yjs, shadcn/ui, Mantine hooks

Server: NodeJS, Hocuspocus, Yjs

Run Locally

Clone the project:

  git clone https://github.com/qwikens/planning-poker/

Open the project directory:

  cd planning-poker

Startup the application:

  ./startup.sh

Run the apps: πŸ₯³

  pnpm --parallel dev

Contributing

Fork the repository:

Fix an issue;

Add tests to your changes;

Make sure the tests are running properly:

pnpm test

Open a pull request:

  • your commits should follow the conventional commits guidelines;
  • your pull request should have a description of the changes and follow the repo's PR template;
  • your pull request should reference the issue you are fixing.

Authors