Skip to content

Commit

Permalink
add readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
@Silent-Watcher
Silent-Watcher committed Oct 8, 2023
1 parent 0822c73 commit 2a3b649
Showing 1 changed file with 13 additions and 75 deletions.
88 changes: 13 additions & 75 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,103 +1,41 @@
![nike-product-card](https://github.com/Silent-Watcher/rock-paper-scissors/blob/master/public/img/Screenshot%20(302).jpg)
<img src="./banner.jpg" alt="nike product card">

# Nike product card

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.
A product card component which you can use in your e-commerce app

<p dir="auto"><a href="https://github.com/sindresorhus/awesome"><img src="https://camo.githubusercontent.com/abb97269de2982c379cbc128bba93ba724d8822bfbe082737772bd4feb59cb54/68747470733a2f2f63646e2e7261776769742e636f6d2f73696e647265736f726875732f617765736f6d652f643733303566333864323966656437386661383536353265336136336531353464643865383832392f6d656469612f62616467652e737667" alt="Awesome" data-canonical-src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" style="max-width: 100%;"></a> <a href="https://github.com/chetanraj/awesome-github-badges"><img src="https://camo.githubusercontent.com/ff817852f0d676a36eaa3108d380e0052e689d9e0bc3eb42818fb21008708420/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d616465253230576974682d4c6f76652d6f72616e67652e737667" alt="Made With Love" data-canonical-src="https://img.shields.io/badge/Made%20With-Love-orange.svg" style="max-width: 100%;"></a>
<a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="commitizen-friendly" style="max-width: 100%;"></a>
</p>

[![Star this project](https://img.shields.io/badge/-⭐%20Star%20this%20project-yellow?style=for-the-badge)](https://github.com/Silent-Watcher/cli-word-guessing-game)
[![Star this project](https://img.shields.io/badge/-⭐%20Star%20this%20project-yellow?style=for-the-badge)](https://github.com/Silent-Watcher/nike-product-card)


## Table of Contents

- [demo](https://github.com/Silent-Watcher/rock-paper-scissors#demo)
- [Features](https://github.com/Silent-Watcher/rock-paper-scissors#features)
- [Prerequisites](https://github.com/Silent-Watcher/rock-paper-scissors#Prerequisites)
- [Installation](https://github.com/Silent-Watcher/rock-paper-scissors#Installation)
- [usage](https://github.com/Silent-Watcher/rock-paper-scissors#usage)
- [Contributing](https://github.com/Silent-Watcher/rock-paper-scissors#Contributing)
- [Contact](https://github.com/Silent-Watcher/rock-paper-scissors#Contact)
- [License](https://github.com/Silent-Watcher/rock-paper-scissors#License)
- [demo](https://github.com/Silent-Watcher/nike-product-card#demo)
- [Contributing](https://github.com/Silent-Watcher/nike-product-card#Contributing)
- [Contact](https://github.com/Silent-Watcher/nike-product-card#Contact)
- [License](https://github.com/Silent-Watcher/nike-product-card#License)

<img align="right" src="./animated%20demo.gif">

## Demo

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

You can try out the game by following this [demo link.](https://silent-watcher.github.io/rock-paper-scissors/)
You can try out the project by following this [demo link.](https://silent-watcher.github.io/nike-product-card/)
<p>

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/Silent-Watcher/rock-paper-scissors)

</p>


## 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.
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/Silent-Watcher/nike-product-card)

## 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:


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

2. Navigate to the project directory in your terminal.


```bash
cd rock-paper-scissors
```
3. Run `npm install` to install the necessary packages.


```bash
npm install
```

4. Run `npm run prepare` to install husky.


```bash
npm run prepare
```

## usage

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

```bash
npm run dev
```
## Technologies
<p>
<a target="_blank" rel="noopener noreferrer nofollow" href="https://camo.githubusercontent.com/96a539d0f4942d7f622d96b43372b8e6038ff508e690609b1ffc1fc3108025bb/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d48544d4c352d3030303f266c6f676f3d68746d6c35266c6f676f436f6c6f723d453334463236"><img src="https://camo.githubusercontent.com/96a539d0f4942d7f622d96b43372b8e6038ff508e690609b1ffc1fc3108025bb/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d48544d4c352d3030303f266c6f676f3d68746d6c35266c6f676f436f6c6f723d453334463236" alt="HTML5" data-canonical-src="https://img.shields.io/badge/-HTML5-000?&amp;logo=html5&amp;logoColor=E34F26" style="max-width: 100%;"></a>
<a target="_blank" rel="noopener noreferrer nofollow" href="https://camo.githubusercontent.com/9aa9859905af6a3b26edde4a73cf1974ed9ae204b16f24f4b704b5cafe1159c2/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d4353532d3030303f266c6f676f3d63737333266c6f676f436f6c6f723d313537324236"><img src="https://camo.githubusercontent.com/9aa9859905af6a3b26edde4a73cf1974ed9ae204b16f24f4b704b5cafe1159c2/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d4353532d3030303f266c6f676f3d63737333266c6f676f436f6c6f723d313537324236" alt="CSS" data-canonical-src="https://img.shields.io/badge/-CSS-000?&amp;logo=css3&amp;logoColor=1572B6" style="max-width: 100%;"></a>
<a target="_blank" rel="noopener noreferrer nofollow" href="https://camo.githubusercontent.com/4b4858ab474b4aaf1d67602c602f1149a7666b04563d1e674a21922d66537b14/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d4a6176615363726970742d3030303f266c6f676f3d4a617661536372697074266c6f676f436f6c6f723d646463353038"><img src="https://camo.githubusercontent.com/4b4858ab474b4aaf1d67602c602f1149a7666b04563d1e674a21922d66537b14/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d4a6176615363726970742d3030303f266c6f676f3d4a617661536372697074266c6f676f436f6c6f723d646463353038" alt="JavaScript" data-canonical-src="https://img.shields.io/badge/-JavaScript-000?&amp;logo=JavaScript&amp;logoColor=ddc508" style="max-width: 100%;"></a>
<a target="_blank" rel="noopener noreferrer nofollow" href="https://camo.githubusercontent.com/404617cc3b075fbc7b1483a9b43d0f6be4aeec1bbd464bf51651c572414009c7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d536173732d3030303f266c6f676f3d53617373"><img src="https://camo.githubusercontent.com/404617cc3b075fbc7b1483a9b43d0f6be4aeec1bbd464bf51651c572414009c7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d536173732d3030303f266c6f676f3d53617373" alt="Sass" data-canonical-src="https://img.shields.io/badge/-Sass-000?&amp;logo=Sass" style="max-width: 100%;"></a>
<a target="_blank" rel="noopener noreferrer nofollow" href="https://camo.githubusercontent.com/9931d101c80aa7cef99bbc377a51936afeb68674645815f815b851fd8de8c470/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d566974652d3030303f266c6f676f3d56697465"><img src="https://camo.githubusercontent.com/9931d101c80aa7cef99bbc377a51936afeb68674645815f815b851fd8de8c470/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d566974652d3030303f266c6f676f3d56697465" alt="Vite" data-canonical-src="https://img.shields.io/badge/-Vite-000?&amp;logo=Vite" style="max-width: 100%;"></a>
</p>

## Contributing 🤝🏾
Expand Down

0 comments on commit 2a3b649

Please sign in to comment.