- Intellij
- Docker
- Maven
- Java 11
- Lombok
Local Host: http://127.0.0.1:8080
Code Climate: https://codeclimate.com/github/bcgov/jag-staffnet
BASIC_AUTH_PASS: The password for the basic authentication. This can be any value for local.
BASIC_AUTH_USER: The username for the basic authentication. This can be any value for local.
ORDS_HOST: The url for ords rest package.
ORDS_USERNAME: ORDS_HOST authentication
ORDS_PASSWORD: ORDS_HOST authentication
ONLINE_SERVICE_ID: Biometrics Online Service Id
WS_URL: webservice url to retrieve biometrics information
WS_AUTH_USER: web service username
WS_AUTH_PASS: web service password
WSDL Endpoint Local:
-
localhost:8080/biometrics/StaffNet_Biometrics.ws.provider:SNBiometrics?WSDL
-
localhost:8080/identity-provisioning/StaffNetIdentityProvisioning.ws.provider:StaffNetIdentityProvisioning?WSDL
SPLUNK_HTTP_URL: The url for the splunk hec.
SPLUNK_TOKEN: The bearer token to authenticate the application.
SPLUNK_INDEX: The index that the application will push logs to. The index must be created in splunk before they can be pushed to.
- Set intellij to use java 11 for the project modals and sdk
- Run
mvn compile
- Make sure
target/generated-sources/xjc
folder in included in module path forstaffnet-common-models
,staffnet-biometrics-models
andstaffnet-identity-provisioning-models
Option A) Intellij
- Create intellij run configuration from Staffnet-Identity-Provisioning and/or Staffnet-Biometrics Application
- Set env variables. See the .env-template
- Run the application
Option B) Jar
- Run
mvn package
- Run
java -jar ./target/staffnet-biometrics-application.jar
orjava -jar ./target/staffnet-identity-provisioning-application.jar
Option C) Docker (* being biometrics/identity-provisioning)
- Run
mvn package
- Run
docker build -t staffnet-*-api .
from root folder - Run
docker run -p 8080:8080 staffnet-*-api
Option D) Eclipse
- Clone the project into a local folder.
- Import the Maven project using the Maven Project Import Wizard.
- Set Variables either as Windows/Linux Environmental variables or POM goal Environment Variables:
staffnet-biometrics-secrets.BASIC_AUTH_PASS
staffnet-biometrics-secrets.BASIC_AUTH_USER
staffnet-identity-provisioning-secrets.staffnet-biometrics-secrets.BASIC_AUTH_PASS
staffnet-identity-provisioning-secrets.staffnet-biometrics-secrets.BASIC_AUTH_USER
ORDS_HOST
ORDS_USERNAME
ORDS_PASSWORD
SPLUNK_HTTP_URL
SPLUNK_TOKEN
SPLUNK_INDEX
ONLINE_SERVICE_ID
WS_URL
WS_AUTH_USER
WS_AUTH_PASS
- Create POM goals: clean install, spring-boot:run (when running locally).
- Do not commit \CRLF use unix line enders
- Run the linter
mvn spotless:apply
- Run
mvn clean verify
- Open
staffnet-code-coverage/target/site/jacoco-aggregate/index.html
in a browser