emendes28 / poinz

Distributed Planning Poker

PoinZ - Distributed Planning Poker

PoinZ (/pɔɪnts/) is a simple web app for distributed teams in an agile setup. It allows to easily estimate items of interest (e.g. "stories").

The goal was to provide a ready-to-use tool without the hassle of registration/login, setup and a lot of configuration.

Checkout the App at https://poinz.herokuapp.com/

Similar tools are : https://www.pointingpoker.com/ or https://www.planningpoker.com/

Technologies and Frameworks

The PoinZ Client is built with ReactJS and redux. Webpack serves as bundling tool.

The PoinZ Backend is a nodeJS express server.

Contribute

Prerequisites

• You have nodeJS installed at v9+ and npm at v6+.
• You are familiar with npm
• You are familiar with git
• You are familiar with- or eager to learn react
• You are familiar with- or eager to learn redux

Style

Try to adhere to the airbnb style guide. (Run $ npm t in the root directory to lint all files and run tests.)

Development

Prerequisites

• Install nodejs
• Install git

Fork & checkout the repository then install all npm dependencies.

$ npm install (This will also install client and server npm dependencies)

Start the backend

$ cd server/ && npm start

Start the client-serving in dev mode via webpack-dev-server

$ cd client/ && npm start

Then you can open the app at http://localhost:9000/

Build

Our build produces a docker image that contains nodejs and our poinz server. Make sure you have docker installed on your machine and your user is in the "docker" usergroup. ($ sudo groupadd docker and $ sudo usermod -aG docker $USER)

1. Install npm dependencies

We need all dependencies of the server and the client installed.

$ npm i within the project root will do that for us (postinstall in package.json)

2. Build & Pack for deployment

In project root, run

$ npm run build

This will copy all backend and client files to deploy/. And then start the docker build.

See Deployment for more information.

To start the newly build image locally, in detached mode with port forwarding:

$ docker run -p 3000:3000 -d xeronimus/poinz

Command and Events documentation

Our backend handles commands sent by the client over a websocket connection. Every command produces one or multiple events that modify the respective room (aka "aggregate"). Then the events are sent back to the client.

(Somewhat inspired by CQRS.)

See the generated command and event docu;