christianrv29 / planning-poker

:black_joker: Planning Poker® Desktop application built with Electron, React & Typescript

planning-poker

Planify: Planning Poker® Desktop application built with Electron, React & Typescript

Quick start

# clone repo
$ git clone https://github.com/lexmartinez/planning-poker

# open work folder
$ cd planning-poker

# install the dependencies
$ npm install

# run the app on develop mode
$ npm start

Table of Contents

• Development
• Packaging
• Screenshots
• License

Development

Once you have installed all dependencies you can now start developing with:

• npm start or yarn start

It will start a local server with the React app and the Electron application on development mode.

OAuth Login

The App uses GitHub and Google as OAuth providers, so in order to develop and bundle the applications you must create a GitHub OAuth App and/or Google Project and include the given CLIENT_ID and CLIENT_SECRET on ./src/config/oauth.js

Packaging

To bundle code in production mode, run the command bellow, the default output directory is /dist

• npm run dist or yarn dist

Screenshots

License

Planning Poker® is a registered trademark of Mountain Goat Software, LLC.

This project is licensed under MIT License - see the LICENSE.md file for details.