yonatankarp/beat-the-machine-deprecated

Beat The Machine!

Type	Status
CI pipelines
Maintenance
Security

This repository manages the entire Beat the machine! game, which allow you to play the "Hangman Challenge" for auto AI auto-generated images.

To play the game locally on your machine, you can download the latest release jar file and run it using the command:

java -jar beat-the-machine-0.1.0.jar

Go to your browser and enter the following url:

https://localhost

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To run the project you need to install the following:

• JDK 17 or newer

Building the application

The project uses Gradle as a build tool. It already contains ./gradlew wrapper script, so there's no need to install gradle.

To build the project execute the following command:

  ./gradlew build

Running the application

You can run this project directly from Gradle by executing the following command:

./gradlew bootRun

This will start the API container exposing the application's port (set to 80 in this app).

In order to test if the application is up, you can call its health endpoint:

  curl http://localhost:80/health

You should get a response similar to this:

  {"status":"UP"}

And coding style tests

This project uses Spotless Gradle plugin to enforce its code style. The plugin will run automatically after every successful build, test, and assemble stage. However, if you would like to run it manually you can do so by running the following commands:

To apply the code style to the project run:

./gradlew spotlessApply

To check your code without applying any changes you can execute:

./gradlew spotlessCheck

Built With

• OpenJdk 17
• Kotlin
• SpringBoot - The web framework used
• Gradle - Dependency Management
• GitHub Actions - Continuous Integration

Authors

• Yonatan Karp-Rudin - Initial work - yonatankarp

beat-the-machine-deprecated's Issues

Add counter for guesses before the player lose

We would like to count the number of guesses the player is allowed to make before he fails the riddle. If the player failed, the submit button should be disabled and the solution should appear on the screen with an indication that the player didn't manage to solve the riddle.

Guesses are not cleaned when going to the next challange

whenever the player press "next" the current guess should be cleaned from the prompt section

sub-strings are recognized as included

whenever a player types some string that contains a substring that is within the prompt the current code approves it, for example, in the prompt:
the quiet before the storm
if the player type:
whether

it will hit the as it's a sub-string of whether

Give hints to the player

As many of the riddles are hard to solve, we might consider adding some predefined hints to the player that we can give whenever the player decides to ask for them.

prompt is not colored

The prompt displayed to the user is no longer colored with red for masked words, and green for guessed words.

`Submit` button should be disabled after pressing `I Give Up!`

After the player presses the I give up! button, the game should not allow them to enter any more prompts for this challenge