rock-paper-scissors 🕹

This GitHub project is a web-based implementation of the classic Rock-Paper-Scissors game, featuring an interactive user interface, a computer opponent with randomized moves, and score tracking for an enjoyable gaming experience.

Table of Contents

• demo
• Features
• Prerequisites
• Installation
• usage
• Contributing
• Contact
• License

Demo

Experience the power of the rock-paper-scissors by visiting the demo page.

You can try out the game by following this demo link.

Features

• Interactive Gameplay: Users can play the classic Rock-Paper-Scissors game directly through the web interface.
• Computer Opponent: The project includes an AI-based computer opponent that randomly selects its move, providing an opponent for the player to compete against.
• Responsive Design: The web application is designed to work seamlessly on various devices and screen sizes, ensuring a responsive and user-friendly experience.
• Score Tracking: The project keeps track of the user's and computer's scores throughout the game, providing a running tally of wins, losses, and ties.
• Game Result Display: After each round, the application displays the result of the round, indicating whether the player won, lost, or tied with the computer.
• Game Reset: Users have the option to reset the game and start a new round or session with a single click.
• Randomized Computer Moves: The computer's move (rock, paper, or scissors) is randomized to create an element of unpredictability and challenge for the player.
• Winning Condition: The project implements the traditional Rock-Paper-Scissors ruleset to determine the winner of each round, based on the chosen moves.
• User-Friendly Interface: The web interface is designed with a clean and intuitive layout, making it easy for users to understand and play the game.
• Open Source: The project is hosted on GitHub and is open source, allowing developers to explore the codebase, contribute to the project, or use it as a learning resource.

Prerequisites

In order to run this project, you will need to have the following installed on your computer:

• nodejs
• yarn | npm | pnpm

Installation

To install the application, follow these steps:

1. Clone the repository to your local machine:

git clone https://github.com/Silent-Watcher/rock-paper-scissors

2. Navigate to the project directory in your terminal.

  cd rock-paper-scissors

3. Run npm install to install the necessary packages.

  npm install

4. Run npm run prepare to install husky.

  npm run prepare

usage

To start the application, run npm run dev . This will start the application on http://localhost:5173.

npm run dev

Technologies

Contributing 🤝🏾

Contributions to this project are welcome. If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.

Before contributing, please review the contribution guidelines.

Contact

For additional information or inquiries, you can reach out to the project maintainer:

• Name: Silent-Watcher
• Email: [email protected]

Feel free to contact the maintainer for any questions or feedback regarding the project.

License 🔐

MIT

This project is licensed under the MIT License. You are free to modify, distribute, and use the code for personal and commercial purposes. See the LICENSE file for details.

Sponsor ❤

If you like this project, please give it a star ⭐ and/or consider buying me a coffee(s). Every donation is appreciated.