shahdev007/hangman repository overview

Table of Contents

1. About The Project⁠
   • Built With⁠
2. Getting Started⁠
   • Start the Server⁠
   • Screenshots⁠
3. Contributing⁠
4. Contact⁠

⁠About The Project

This project is a Hangman game built with ReactJS, TypeScript, Material-UI, and React-Bootstrap. Players can choose a category and difficulty level on the home page before starting the game. The goal is to guess words with the help of initial hints, within six attempts. The game features both typing and on-screen character buttons for input. After each game, a win or loss message is displayed, and players are redirected to the home page to start a new game.

⁠Built With

Frameworks/libraries used to bootstrap this project:

• 
• ](https://github.com/ellerbrock/typescript-badges/⁠)
• 
• 
• 
• 

(Back to Top⁠)

⁠Getting Started

This project was bootstrapped with npm-create-vite.

⁠Installation

1. Clone the repo

   git clone https://github.com/ShahDev007/Typescript_Hangman.git
   

   Copy
2. Install NPM packages

   npm install
   

   Copy

or

1. Pull the image uploaded on Docker:- https://hub.docker.com/r/shahdev007/hangman⁠

⁠Start the Server

npm run dev

Runs the app in the development mode.
Open http://localhost:5173⁠ to view it in the browser.

---

(Back to top⁠)

⁠Screenshots

(Back to Top⁠)

⁠Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(Back to Top⁠)

⁠Contact

Dev Shah - https://www.linkedin.com/in/dev-shah-437528194/⁠
Project Link: https://github.com/ShahDev007/Typescript_Hangman/⁠

(Back to Top⁠)