CDDS webMethods Retirement Project
- Intellij
- Docker
- Docker Compose
- Maven
- Java 11
- Lombok
Local Host: http://127.0.0.1:8080
Code Climate: https://codeclimate.com/github/bcgov/jag-cdds
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.
SPLUNK_HTTP_URL: The url for the splunk hec. For local splunk this value should be 127.0.0.1:8088 for remote do not include /services/collector.
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
Option A) Intellij
- Create intellij run configuration from CDDS Application
- Set env variables. See the .env-template
- Run the application
Option B) Jar
- Run
mvn package
- Run
java -jar ./target/cdds-application.jar
Option C) Docker
- Run
mvn package
- Run
docker build -t cdds-civil-api .
from root folder - Run
docker run -p 8080:8080 cdds-civil-api
Option D) Docker Compose
- Run
mvn package
- Run
docker-compose up cdds-civil-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:
BASIC_AUTH_PASS
BASIC_AUTH_USER
ORDS_HOST
SPLUNK_HTTP_URL
SPLUNK_TOKEN
SPLUNK_INDEX
- 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
target/site/jacoco/index.html
in a browser