diff --git a/README.md b/README.md index ae7483f..dcea9fd 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,32 @@ Currently we rely on CPaaS to submit requests to PSSaaS which then invokes the P Our api will be written in Quarkus for ease of use and deployment to OpenShift, we will also use Tekton to assist with CI/CD. # How to build + +To set up the environment. After cloning the repository: + +``` +cd / +quarkus create app quarkus:dev +mvn -N io.takari:maven:wrapper +``` + +Also, it is necessary to create a local PostgreSQL instance. For development purposes, the parameters are: +``` +username = postgresql +password = password +``` + +ToDo: Create Database Model + + + To run the Quarkus build in dev mode simply run: +```` ./mvnw compile quarkus:dev +```` All end points should be avaliable on localhost:8080/{endpoint}. The endpoints are listed in the endpoints section -Need to add the maven parameters for PSGQLauth + # Deploying to OpenShift (https://quarkus.io/guides/deploying-to-openshift) Part of the advantage of working with quarkus is the ease of which we can deploy it to OpenShift. We have the OpenShift extension already installed via the pom,