Cod-e-Codes/partydice-react

An engaging React-based dice game for parties. PartyDice (React) allows players to roll dice, complete challenges, and compete for the highest score with interactive gameplay and a dynamic scoreboard.

PartyDice (React)

Welcome to PartyDice, a dynamic and engaging Vite-powered React application designed for fun and interactive gameplay. Whether you're hosting a game night or enjoying some friendly competition, PartyDice (React) provides an exciting platform for players to roll dice, complete challenges, and compete to reach the highest score.

Table of Contents

• Features
• Demo
• Installation
• Usage
• Technologies Used
• Contributing
• License
• Author

Features

• Player Management: Add up to 8 players, assign names and genders, and manage player participation seamlessly.
• Game Modes: Choose between Quick Play (target score: 50) and Full Game (target score: 100) to suit your gameplay preferences.
• Interactive Gameplay: Roll dice to receive random challenges based on player attributes and earn points upon completion.
• Real-Time Scoreboard: Track player scores in real-time with a dynamic scoreboard that highlights the current leader.
• Recent Rolls Log: Keep track of recent dice rolls and challenges with a detailed history log.
• Winner Announcement: Celebrate the winning player with a dedicated winner dialog upon reaching the target score.
• End Game Early: Flexibly end the game at any point with a confirmation dialog to ensure intentional actions.
• Responsive Design: Enjoy a seamless experience across various devices and screen sizes, ensuring fun anytime, anywhere.

Demo

Experience PartyDice (React) live on GitHub Pages.

Installation

To set up the project locally, follow these steps:

1. Clone the Repository:

   git clone https://github.com/Cod-e-Codes/partydice-react.git

2. Navigate to the Project Directory:

   cd partydice-react

3. Install Dependencies:

   Ensure you have Node.js installed. Then, install the required packages:

   npm install

   or if you're using Yarn:

   yarn install

Usage

1. Start the Development Server:

   npm run dev

   or with Yarn:

   yarn dev

2. Open the Application:

   Navigate to http://localhost:3000 in your browser to view the application.

3. Gameplay Steps:

   • Add Players: Enter player details to add participants to the game.
   • Select Game Mode: Choose between Quick Play or Full Game using the GameModeSelector.
   • Start Game: Begin the game and take turns rolling the dice.
   • Complete Challenges: Fulfill or skip challenges to earn points.
   • Track Scores: Monitor player scores and recent rolls.
   • End Game: Either let the game conclude naturally or end it early using the provided option.

Technologies Used

• Vite: Fast frontend build tool for modern web projects.
• React: JavaScript library for building user interfaces.
• TypeScript: Typed superset of JavaScript for enhanced code quality.
• Tailwind CSS: Utility-first CSS framework for rapid UI development.
• React Router DOM: Declarative routing for React applications.
• GitHub Pages: Hosting service for static websites.
• gh-pages: NPM package to publish files to a gh-pages branch on GitHub.

Contributing

Contributions are welcome! If you'd like to contribute to PartyDice (React), please follow these steps:

1. Fork the Repository:

   Click the Fork button at the top right of the repository page.

2. Create a New Branch:

   git checkout -b feature/YourFeatureName

3. Make Your Changes:

   Implement your feature or fix the issue.

4. Commit Your Changes:

   git commit -m "Add your message here"

5. Push to Your Fork:

   git push origin feature/YourFeatureName

6. Create a Pull Request:

   Navigate to the original repository and click New pull request. Provide a clear description of your changes.

License

This project is licensed under the MIT License.

Author

Created by CodēCodes/Cody Marsengill
GitHub | LinkedIn

---