geraertsf / pithy-judge

Generated by the Red Hat Developer Launcher (https://developers.redhat.com/launch)

REST API Level 0 - Spring Boot Example Application

Important

This example application requires Java 8 JDK or greater and Maven 3.3.x or greater.

Important

As part of the process of creating this example application using developers.redhat.com/launch or the Fabric8 Launcher tool, set up a project with a CI/CD deployment of this example application. You can see the status of this deployment in your Single-node OpenShift Cluster or OpenShift Online Web Console.

Running the Example Application Locally

To run this example application on your local host:

$ git clone [e-mail]:midryndhil/pithy-judge

$ cd pithy-judge

$ mvn spring-boot:run

Interacting with the Example Application Locally

To interact with your example application while it’s running locally, use the form at http://localhost:8080 or the curl command:

$ curl http://localhost:8080/api/greeting
{"content":"Hello, World!"}

$ curl http://localhost:8080/api/greeting?name=Sarah
{"content":"Hello, Sarah!"}

Updating the Example Application

To update your example application:

1. Stop your example application.

   Note	To stop your running example application in a Linux or macOS terminal, use CTRL+C. In a Windows command prompt, you can use CTRL + Break(pause).

2. Make your change (e.g. edit src/main/resources/static/index.html).

3. Restart your example application.

4. Verify the change took effect.

Running the Example Application on a Single-node OpenShift Cluster

If you have a single-node OpenShift cluster, such as Minishift or Red Hat Container Development Kit, installed and running, you can also deploy your example application there. A single-node OpenShift cluster provides you with access to a cloud environment that is similar to a production environment.

To deploy your example application to a running single-node OpenShift cluster:

$ oc login -u developer -p developer

$ oc new-project MY_PROJECT_NAME

$ mvn clean fabric8:deploy -Popenshift

More Information

You can learn more about this example application and rest of the Spring Boot runtime in the Spring Boot Runtime Guide.

Note	Run the set of integration tests included with this example application using mvn clean verify -Popenshift,openshift-it.