https://github.com/mateuskoppe/planning-poker

Estimate your tasks easily
https://github.com/mateuskoppe/planning-poker

nodejs react socket-io styled-components typescript

Last synced: about 2 months ago
JSON representation

Estimate your tasks easily

• Host: GitHub
• URL: https://github.com/mateuskoppe/planning-poker
• Owner: mateusKoppe
• License: mit
• Created: 2020-08-13T23:53:07.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-22T04:04:01.000Z (almost 3 years ago)
• Last Synced: 2024-05-28T00:18:00.717Z (8 months ago)
• Topics: nodejs, react, socket-io, styled-components, typescript
• Language: TypeScript
• Homepage: http://planning-with-poker.herokuapp.com/
• Size: 1.57 MB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Planning Poker

> Estimate your tasks easily

![demo](./docs/demo.gif)

This app provides a simple, real-time and easy-to-use interface to help your team estimate the tasks in your sprints.

### Built with

- [React](https://reactjs.org/)

- [NodeJs](https://nodejs.org/en/)

- [TypeScript](https://www.typescriptlang.org/)

- [Styled Components](https://styled-components.com/)

- [Socket.io](https://socket.io)

## Getting Started

To make the app run is a very straightforward process:

```bash

yarn

yarn build

yarn start

```

It will spin-up a server on the port `8080`.

You can change this with the `REACT_APP_API_PORT` environment variable:

```

REACT_APP_API_PORT=80 yarn start

```

## Development

To make changes in the repository and use the dev environment:

```bash

yarn

yarn dev

```

## Deploying

When you deploy the application you will probably want to change the `REACT_APP_API_PORT` and `REACT_APP_API_DOMAIN` environment variables:

```bash

REACT_APP_API_PORT=80 REACT_APP_API_DOMAIN=myplanningpai.com yarn build

# You don't need the domain to start

# Don't forget to use the same port when you start the API

REACT_APP_API_PORT=80 yarn start

```

## License

Distributed under the MIT License. See `LICENSE` for more information.