Skip to content

Latest commit

 

History

History
107 lines (71 loc) · 1.86 KB

README.md

File metadata and controls

107 lines (71 loc) · 1.86 KB
Raw

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 🌍🌎🌏!

PokerPlanning.org Room demo

Features 🚀

  • Free to use
  • Real-time collaboration
  • Intuitive user interface
  • Customizable estimation scales (WIP)
  • Instant results visualization (WIP)

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:

    git clone https://github.com/ModPhoenix/poker-planning.git
cd poker-planning

  2. Install cargo-watch (for development):

    cargo install cargo-watch

Running the Server

  1. Navigate to the server directory:

    cd server

  2. Start the development server:

    cargo watch -x run

Running the Web App

  1. Navigate to the client directory:

    cd client

  2. Copy the example environment file:

    cp .env.local.example .env.local

  3. Install dependencies:

    npm install

  4. Start the development server:

    npm run dev

Deployment

This project can be deployed using DigitalOcean App Platform. Use the following commands with the DigitalOcean CLI:

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.