https://github.com/vpavlin/vpavlin-prod-prev-test
https://github.com/vpavlin/vpavlin-prod-prev-test
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vpavlin/vpavlin-prod-prev-test
- Owner: vpavlin
- License: apache-2.0
- Created: 2017-10-18T07:23:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-30T17:07:43.000Z (over 7 years ago)
- Last Synced: 2025-01-23T03:44:40.799Z (4 months ago)
- Language: HTML
- Homepage:
- Size: 53.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
= REST API Level 0 - Eclipse Vert.x Booster
IMPORTANT: This booster requires Java 8 or greater and Maven 3.3.x or greater.
IMPORTANT: As part of the process of creating this booster, launch.openshift.io set up a project with a CI/CD deployment of this booster. You can see the status of this deployment in your Single-node OpenShift Cluster or OpenShift Online Web Console.
== Run this Booster Locally
To run this booster on your local host:
[source,bash,options="nowrap",subs="attributes+"]
----
$ git clone [email protected]:${loggedUser}/vpavlin-prod-prev-test
$ cd vpavlin-prod-prev-test
$ mvn compile vertx:run
----
== Interact with this Booster Locally
To interact with your booster while it's running locally, use the form at `http://localhost:8080` or the `curl` command:
[source,bash,options="nowrap",subs="attributes+"]
----
$ curl http://localhost:8080/api/greeting
{"content":"Hello, World!"}
$ curl http://localhost:8080/api/greeting?name=Sarah
{"content":"Hello, Sarah!"}
----
== Update this Booster
To update your booster:
. Stop your booster.
+
NOTE: To stop your running booster in a Linux or macOS terminal, use `CTRL+C`. In a Windows command prompt, you can use `CTRL + Break(pause)`.
. Make your change (e.g. edit `src/main/resources/webroot/index.html`).
. Restart your booster.
. Confirm your change appears.
== Run this Booster on a Single-node OpenShift Cluster
If you have a single-node OpenShift cluster, such as Minishift or the Red Hat Container Development Kit, link:http://appdev.openshift.io/docs/minishift-installation.html[installed and running], you can also deploy your booster there. A single-node OpenShift cluster provides you with access to a cloud environment that is similar to a production environment.
To deploy your booster to a running single-node OpenShift cluster:
[source,bash,options="nowrap",subs="attributes+"]
----
$ 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 booster and rest of the Eclipse Vert.x runtime in the link:http://appdev.openshift.io/docs/vertx-runtime.html[Eclipse Vert.x Runtime Guide].