grass-team

README.md

@@ -1,26 +1,38 @@
-# Create a game
+# ReactJS Hangman Game
+
+### Built With
+
+- [React ](https://reactjs.org/)- A JavaScript library for building user interfaces
+
+#### Resulting image looks something like this:
 
-## Overview
-Create a hangman game! <br>
-Example of what we want to accomplish
 ![Example of hangman game](images/example.jpg)
-### Requirements
-
-1. HTML:
-    1. Add buttons that correspond to each letter from a to z.
-    2. Add a section that will hold the blanks that are going to be equal to the number of characters for the current word.
-    3. Add a div to show the man who's going to be hanged if you lose.
-    4. Add a counter from 10 that will decrease by 1 with every wrong guess.
-    4. Add a button to play again.
-
-2. JS:
-    1. At the beginning use fetch API to retrieve a random word from this api https://random-word-api.herokuapp.com/word?number=1. Make the blanks equal the number of letters in the random word.
-    2. Everytime the user clicks on one of the letters the following should happen:
-        1. The random word is search through to find if it contains the clicked letter, if the clicked letter is part of the random word's letters then it gets shown up instead of the space, if not, then the lives counter is decreased by one. In some rare cases a clicked letter corresponds to two letters in the generated word, if that happens then show both words.
-        2. The button becomes disabled and should only work once.
-    3. If the lives counter reaches 0 then the game is over and the hangman should be HANGED! 👨‍🦱🔪
-    4. Clicking on the play again button should do the whole process again.
-
-
-NOTE: Be creative with the game's mechanics and design!!! 
-Have fun, and Good luck :D 
+
+## How to play
+
+Try to discover the answer for the question choosing letter by letter. If the letter is not contained in the answer, a portion of the hangman is added and you will lose a chance.
+The game ends when you discover the answer before the hangman is formed or when you do not have more attempts to play!
+
+## Specifications
+
+- Generate random words by fetching Api
+
+### Dependencies
+
+- Node: [http://nodejs.org/](http://nodejs.org/)
+- ReactJS: [https://reactjs.org](https://reactjs.org)
+
+### Initial Set Up
+
+1. Clone the repository
+2. `npm install` or `yarn`
+3. `npm start` or `yarn start` app start with your port number
+
+--------------------------------------------------------------
+### UI design here
+- Link : [https://xd.adobe.com/view/f759723c-c8d2-46a8-859e-4dba9ec99e06-a20a/](https://xd.adobe.com/view/f759723c-c8d2-46a8-859e-4dba9ec99e06-a20a)
+
+### Play here
+
+- Link : [https://grass-team-hangman-reactjs.netlify.app/](https://grass-team-hangman-reactjs.netlify.app)
+