Welcome to the Hangman Game — a fun and interactive Game built with React!
 |
 |
 |
 |
 |
 |
To run the application. Follow the steps below:
-
Clone this project using the following command:
git clone https://github.com/oyerohabib/fun-hangman-game.git
-
Navigate to the project directory:
cd fun-hangman-game -
Install the dependencies:
npm install
-
Start the project:
npm run start
-
To run the test cases, use:
npm run test
Alternatively, you can run the application using Docker, after step 2 above, run the below commands:
-
Build the Docker Image:
docker build -t fun-hangman-game . -
Run the Docker Container:
docker run -p 3000:3000 -d fun-hangman-game
Alternatively, you can pull the docker image (from docker hub) and simply run, without having to build or clone it.
-
Pull the Docker Image:
docker pull habibo1234/fun-hangman-game:1.0
-
Pull the Docker Image:
docker run -p 3000:3000 -d habibo1234/fun-hangman-game:1.0
Now, you should have the project running locally. Visit http://localhost:3000 in your browser to play the Hangman Game.
Enjoy the game using the on-screen instructions and have fun guessing the words! 🎉
- User Authentication (to be able to save progress etc.)
- Analytics (To show various statistics)
- Leaderboard (where people can see their rankings)
- AI Assistant (to help provide tips or hints for the words)
- SASS Platform (where the host can uplaod their own dictionary of words)
Thank you for considering contributing to the Hangman Game! We welcome contributions from the community to help improve and grow the project.
Please note that this project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior.
This project is licensed under the MIT License.