Skip to content

brendan-sadlier/pokero

Repository files navigation

GitHub Actions Workflow Status License: CC BY-NC-SA 4.0


Pokero

Pokero makes planning poker effortless. Start a session in seconds, invite your team, and estimate together without distractions.

No logins

No clutter

Just fast, fun, accurate planning

👉 Try it live: https://pokero.dev

About The Project

Product Name Screen Shot

🚀 Features

  • 🔮 Real-time planning poker estimation

  • 🔗 Shareable session links — no signup required

  • 🎨 Clean, distraction-free UI

  • ⚡️ Built with lightning-fast web tech

  • 📱 Responsive and team-friendly on all devices

🛠️ Built With

Vite React Typescript Tailwind Shadcn

💻 Running Locally

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

1️⃣ Clone the Repository

git clone https://github.com/brendan-sadlier/pokero.git
cd pokero

2️⃣ Install Dependencies

npm install

3️⃣ Start the Frontend

npm run dev

4️⃣ Start the Backend (PartyKit)

npx partykit dev

🎉 That’s it! No environment variables needed.

🗂️ Project Structure

pokero/
├── src/ # Frontend source
│ ├── components/ # UI Components (Shadcn + custom)
│ ├── lib/ # Utility files
│ ├── pages/ # App pages + routing
│ ├── types/ # Data Types
│ └── ...
├── partykit/ # Real-time server logic
├── public/ # Static assets
└── package.json

🤝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📜 License

This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0).

You are free to use, modify, and share this project for non-commercial purposes, as long as you:

  • Provide attribution to Brendan Sadlier
  • Share any derivative works under the same license
  • Do not use the project, name, or code for commercial gain

🔗 Full license: https://creativecommons.org/licenses/by-nc-sa/4.0/

About

Pokero makes planning poker effortless. Start a session in seconds, invite your team, and estimate together without distractions. No logins , No clutter. Just fast, fun, accurate planning

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors

Languages