https://github.com/INQTR/poker-planning
PokerPlanning.org is perfect for Agile workflows, our tool makes consensus-based estimation simple, fun, and effective.
https://github.com/INQTR/poker-planning
agile estimation planning-poker poker-planning scrum scrum-poker stories
Last synced: about 2 months ago
JSON representation
PokerPlanning.org is perfect for Agile workflows, our tool makes consensus-based estimation simple, fun, and effective.
- Host: GitHub
- URL: https://github.com/INQTR/poker-planning
- Owner: INQTR
- License: mit
- Created: 2021-09-24T23:27:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-31T23:04:57.000Z (3 months ago)
- Last Synced: 2025-02-01T00:18:13.033Z (3 months ago)
- Topics: agile, estimation, planning-poker, poker-planning, scrum, scrum-poker, stories
- Language: TypeScript
- Homepage: https://pokerplanning.org/
- Size: 3.15 MB
- Stars: 78
- Watchers: 3
- Forks: 22
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PokerPlanning.org
PokerPlanning.org is an open-source, user-friendly online planning poker tool designed to enhance Scrum team collaboration and improve estimation accuracy. Our mission is to provide a free, accessible, and enjoyable planning poker experience for teams worldwide 🌍🌎🌏!
## Features 🚀
- Free to use
- Real-time collaboration
- Intuitive user interface
- Instant results visualization
- Customizable estimation scales (WIP)
# TODO
- [ ] Customizable estimation scales
- [ ] Spectator mode
## Technology Stack 🛠️
### Server-side
- Rust 🦀
- async-graphql 🚀
### Client-side
- TypeScript 🦺
- React ⚛️
- Apollo Client 📡
- shadcn/ui 😮💨
## Getting Started 🏁
### Prerequisites
- Git
- Rust
- Node.js and npm
### Setup
1. Clone the repository:
```sh
git clone https://github.com/INQTR/poker-planning.git
cd poker-planning
```
2. Install cargo-watch (for development):
```sh
cargo install cargo-watch
```
### Running the Server
1. Navigate to the server directory:
```sh
cd server
```
2. Start the development server:
```sh
cargo watch -x run
```
### Running the Web App
1. Navigate to the client directory:
```sh
cd client
```
2. Copy the example environment file:
```sh
cp .env.local.example .env.local
```
3. Install dependencies:
```sh
npm install
```
4. Start the development server:
```sh
npm run dev
```
## Running Tests 🧪
This project uses Vitest for unit and integration tests, and Playwright for end-to-end tests.
### Unit and Integration Tests
To run unit and integration tests:
```sh
npm t
```
### End-to-End Tests
To run end-to-end tests:
```sh
npm run test:e2e
```
To run end-to-end tests with UI:
```sh
npm run test:e2e:ui
```
## Deployment
This project can be deployed using DigitalOcean App Platform. Use the following commands with the DigitalOcean CLI:
```sh
doctl auth init
doctl apps create --spec spec.yaml
doctl apps list
doctl apps update APP-ID --spec=spec.yaml
```
## Contributing 🤝
We welcome contributions! Please feel free to submit a Pull Request.
## License 📜
This project is open source and available under the [MIT License](LICENSE).