https://github.com/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.
https://github.com/cod-e-codes/partydice-react
dice-game github-pages partygame react tailwindcss typescript vite
Last synced: 10 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/cod-e-codes/partydice-react
- Owner: Cod-e-Codes
- License: mit
- Created: 2024-12-03T00:45:53.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-03T01:10:00.000Z (about 1 year ago)
- Last Synced: 2025-01-04T20:42:34.076Z (12 months ago)
- Topics: dice-game, github-pages, partygame, react, tailwindcss, typescript, vite
- Language: TypeScript
- Homepage: https://cod-e-codes.github.io/partydice-react/
- Size: 325 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](#features)
- [Demo](#demo)
- [Installation](#installation)
- [Usage](#usage)
- [Technologies Used](#technologies-used)
- [Contributing](#contributing)
- [License](#license)
- [Author](#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](https://Cod-e-Codes.github.io/partydice-react/).
## Installation
To set up the project locally, follow these steps:
1. **Clone the Repository:**
```bash
git clone https://github.com/Cod-e-Codes/partydice-react.git
```
2. **Navigate to the Project Directory:**
```bash
cd partydice-react
```
3. **Install Dependencies:**
Ensure you have [Node.js](https://nodejs.org/) installed. Then, install the required packages:
```bash
npm install
```
or if you're using Yarn:
```bash
yarn install
```
## Usage
1. **Start the Development Server:**
```bash
npm run dev
```
or with Yarn:
```bash
yarn dev
```
2. **Open the Application:**
Navigate to [http://localhost:3000](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](https://github.com/Cod-e-Codes/partydice-react/fork) button at the top right of the repository page.
2. **Create a New Branch:**
```bash
git checkout -b feature/YourFeatureName
```
3. **Make Your Changes:**
Implement your feature or fix the issue.
4. **Commit Your Changes:**
```bash
git commit -m "Add your message here"
```
5. **Push to Your Fork:**
```bash
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](LICENSE).
## Author
Created by [CodēCodes/Cody Marsengill](https://www.cod-e-codes.com/)
[GitHub](https://github.com/Cod-e-Codes) | [LinkedIn](https://www.linkedin.com/in/cod-e-codes/)
---