/yonathan-beat-the-machine

Primary LanguageKotlin

Beat The Machine!

Type Status
CI pipelines Build Build
Maintenance Quality Gate Status Maintainability Rating Technical Debt
Security Security Rating Vulnerabilities

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

welcome screen

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

Authors