Skip to content

local-development.md

Latest commit

 

History

History
93 lines (67 loc) · 3.02 KB

local-development.md

File metadata and controls

93 lines (67 loc) · 3.02 KB
Raw

Local development

No considerations are made in these instructions and notes around system security.

For local development, say in an IDE system, HDS can be launched as a SpringBoot application.

Preparation

  1. Install the necessary software for HDS
  • Java 25+
  • Postgres Database Server and Client 14+
  • Python 3
  • Podman
  1. Setup the database server
  • Listening on a TCP/IP socket
  • Empty database
  • User with password to access the database
  1. Create a .yaml file somewhere on the local storage and configure the following keys in that file as appropriate. See the application.yaml file in the source code for documentation.
  • spring.datasource.url
  • spring.datasource.username
  • spring.datasource.password
  • spring.mail.host
  • hds.deployment.is-production
  • hds.base-url
  • hds.authentication.jws.issuer
  • server.port
  • hds.graphics-server.base-uri

If you don't have an SMTP mail host this can be omitted for a development scenario unless you want to test those functions such as "forgot password".

Run from Maven

Build the applications with;

./mvnw clean install

Run the HDS application server with;

cd haikudepotserver-webapp

../mvnw \
spring-boot:run \
-Dfile.encoding=UTF-8 \
-Duser.timezone=GMT0 \
-Djava.awt.headless=true
-Drun.arguments=--spring.config.additional-location=file:///path/to/config.yaml

The application can be accessed using a web browser on http://localhost:8080 on the development host; assuming 8080 is the configured value for server.port. Login as root with password zimmer.

Run the graphics application

Without the graphics server running, some icons and screenshots will not display. Run the graphics server with;

cd haikudepotserver-server-graphics

SERVER_PORT=8085 \
HDS_TOOL_HVIF2PNG_PATH=/x/y/z/hvif2png \
HDS_TOOL_OXIPNG_PATH=/r/s/t/oxipng \
HDS_GFX_QUANTIZE=false \
../mvnw \
spring-boot:run \
-Dfile.encoding=UTF-8 \
-Duser.timezone=GMT0 \
-Djava.awt.headless=true

Modify the configuration property hds.graphics-server.base-uri set when running the HDS application server to have value http://localhost:8085. Re-run the HDS application server.

Run from the Intelli-J IDE

The Intelli-J IDE can be used to run the HDS SpringBoot application. Locate the file src/main/java/org/haiku/haikudepotserver/Application.java and choose the Debug option on the context menu for this file. You will need to add the -Drun.arguments=--spring.config.additional-location=file:///path/to/config.yaml program arguments and the following JVM arguments;

  • -Dfile.encoding=UTF-8
  • -Duser.timezone=GMT0
  • -Djava.awt.headless=true

The application can be accessed using a web browser on http://localhost:8080 on the development host. Login as root with password zimmer.

Run integration-tests

The HDS application has a number of integration tests. Run the integration tests with;

./mvnw clean verify

The tests will automatically launch a Postgres database to test against using Docker.