Peculiar Planning Poker

A planning poker app for agile teams to estimate work items using the Fibonacci sequence.

Example Procedure

Here is a typical procedure to use PPP during your agile ceremonies:

1. Log into PPP with your team.
2. Present a user story to estimate.
3. Ask the team to vote on the story by selecting a card.
4. Once everyone has voted, the consensus estimation is displayed.
5. Click "Reset All Estimations" to start the process again with a new user story.

Happy estimating!

Card Texts

To modify the card texts, edit the CARDS map in src/model/cards.js.

Usage

Running the latest build

To run the latest build of PPP, you can use Docker:

1. Build the image: docker build --build-arg REACT_APP_BACKEND_HOSTNAME=<host name> -t ppp .
   • Replace <host name> with host name of the server this app runs on (e.g. "my-website" without a protocol and port). Browsers will connect to this host via http.
   • Omit the --build-arg argument to default to "localhost" (only makes sense for local Docker image testing): docker build -t ppp .
2. Run the container: docker run -d --rm -p 3000:3000 -p 3001:3001 --name ppp ppp
3. Open a web browser and go to: http://<host name>:3000

Running PPP locally during development

To run PPP locally during development, you can follow these steps:

1. Clone this repository and cd into it
2. Install dependencies: yarn
3. Start the server: yarn backend (this will bind port 3001)
4. Start the React app: yarn start (this will bind port 3000)
5. Open a web browser and go to: http://localhost:3000. Open multiple tabs to simulate multiple users.

Debugging server.js with VS Code

To debug the server.js file with VS Code, you can use the following steps:

1. Open the project in VS Code
2. Open the Debug view (Ctrl + Shift + D or Cmd + Shift + D)
3. Select "Debug Server" from the dropdown menu in the top menu bar
4. Set any necessary breakpoints in the server.js file
5. Press the "Start Debugging" button (green arrow) or hit F5
6. The server should start and pause on any set breakpoints

Contributing

Contributions to this project are welcome! To get started, fork the repository, make changes, and submit a pull request. To work on an existing issue, feel free to assign yourself. For new bug reports or feature requests, please create a new issue.

For more information on contributing to GitHub projects, please see https://docs.github.com/en/get-started/quickstart/contributing-to-projects. Your contributions are appreciated, and thank you for considering to collaborate with this project!

Developer Hints

The server.js manages the state of all users and estimations to ensure consistency among clients.

Useful Resources

• https://socket.io/docs/v4/emit-cheatsheet/
• https://dev.to/bravemaster619/how-to-use-socket-io-client-correctly-in-react-app-o65