From 2a3b649173a3f7d5b63ac9a4b75fd8f4112d5e31 Mon Sep 17 00:00:00 2001 From: "Ali.t.nazari" Date: Sun, 8 Oct 2023 23:12:56 +0330 Subject: [PATCH] add readme file --- README.md | 88 ++++++++----------------------------------------------- 1 file changed, 13 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 78f9b39..a941efc 100644 --- a/README.md +++ b/README.md @@ -1,103 +1,41 @@ -![nike-product-card](https://github.com/Silent-Watcher/rock-paper-scissors/blob/master/public/img/Screenshot%20(302).jpg) +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

Awesome Made With Love -commitizen-friendly

-[![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) + + ## 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/)

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

- - -## 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. +

-```bash -npm run dev -``` ## Technologies

HTML5 CSS - JavaScript -Sass -Vite

## Contributing 🤝🏾