Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/halomakes/poker
Planning poker with SignalR
https://github.com/halomakes/poker
angular aspnetcore scrum-poker signalr websockets
Last synced: 6 days ago
JSON representation
Planning poker with SignalR
- Host: GitHub
- URL: https://github.com/halomakes/poker
- Owner: halomakes
- License: mit
- Created: 2019-01-10T22:29:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T18:33:22.000Z (almost 2 years ago)
- Last Synced: 2024-04-13T18:44:33.621Z (10 months ago)
- Topics: angular, aspnetcore, scrum-poker, signalr, websockets
- Language: TypeScript
- Homepage: https://app.planning.rocks
- Size: 3.46 MB
- Stars: 41
- Watchers: 3
- Forks: 13
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PokeR
[](https://travis-ci.org/halomademeapc/pokeR) [](https://hub.docker.com/repository/docker/halomademeapc/poker)
Realtime planning poker with [SignalR](https://github.com/SignalR/SignalR).
*Check out [the demo](https://app.planning.rocks)!*
PokeR is a realtime planning poker app built with .NET Core and Angular. It features a custom-built frontend with some slick animations to make your next planning session just a little bit nicer. There's also a REST API that you can use to customize the game to your liking.
PokeR uses Entity Framework Core in-memory. If you need persistence for some reason, you can swap this out for SQLite or another provider. Data is seeded on startup from the json files in the project's root directory. You can also edit options via the exposed REST API. Documentation for the API can be viewed in the Swagger UI at `/swagger`.
## Quickstart
The easiest way to get going is by pulling down a ready-to-go image from Docker Hub.
```powershell
docker run --name poker --restart always -d -p 80:80 halomademeapc/poker
```
## Overview
You can pick any integer that isn't already taken to be your room number. This number will appear in share links to your room. Options for the deck to play with are Modified Fibonacci (.5, 1, 2, 3, 5, 8, 13, 20) and T-Shirt Sizes, but more can be added by configuring the defaults JSON file or by posting new decks to the REST API at runtime.
Users can join your room by going directly to `/rooms/{roomId}` or by going to the homepage and clicking on the "Join a room" button. The first person into the room (assumed to be the person who created it) is designated as the host and gets extra controls to manage voting.
If you need to change who is in the host role, expanding the Roster tab on the left then dragging-and-dropping the crown icon onto another user will transfer ownership of the room to them.
Cards are played face-down and revealed once everyone has played. If someone changes their vote mid-round, you will see an animation of the original card being withdrawn and the new one being played in its stead.
If everybody happens to have the same vote, you'll be greeted with some celebratory confetti for the concensus courtesy of [confetti-js](https://www.npmjs.com/package/confetti-js). One danger with this is that people like it so much it can start to encourage groupthink.
If a user is AFK or otherwise responsive and is holding things up, the host can set a deadline for the voting round. Everyone will see the countdown and once time is up, votes will be revealed even if not everyone has responded.
The host can begin a new round to clear out any existing votes and start things off fresh.
 
The app will respect your OS dark mode preference by default. If you hover over the icon in the top-right corner, you can switch themes manually.
## Requirements
**To build**
* .NET 6 SDK
* Node.js
**To run**
* .NET 6 Runtime
## Building
```powershell
dotnet publish ./PokeR.csproj
```
## Running
```powershell
dotnet ./PokeR.dll
```