Welcome to Hangman, a simple React app built with TypeScript! This project is a digital version of the classic word-guessing game, where players attempt to guess a hidden word letter by letter.
- React: A JavaScript library for building user interfaces.
- TypeScript: A statically-typed superset of JavaScript, adding type annotations and other features.
- Vite: A fast, opinionated web dev build tool.
- SCSS: Syntactically Awesome Style Sheets for styling the app.
- HTML: Hypertext Markup Language for structuring the app.
- Choose game language (Currently, the app supports English and German)
- Enter a letter in the input field (You can use keyboard letters or click the buttons on the screen)
- If the letter is correct, it will be revealed in the word. Otherwise, a part of the hangman drawing will appear (and wrong letter will be disabled)
- Keep guessing letters until you either complete the word or the hangman drawing is fully displayed.If you complete the word, you win the game and the confetti animation will appear!
- You can reset the game at any time by clicking the "Reset" button, refresh the page or simply press Enter
You'll need to install dependencies and start the Vite development server:
npm install
npm run devYou'll find the running game at http://localhost:5173
Tests are written with the React Testing Library. Run all of them via
npm run testContributions to the Hangman React app are welcome! If you have any suggestions, bug reports, or feature requests, feel free to submit an issue or a pull request.
This project is licensed under the MIT License. Feel free to use, modify, and distribute the code as per the terms of the license.
Thank you for checking out the Hangman React app! Have fun playing and improving your word-guessing skills. If you have any questions, feel free to reach out. Happy gaming!