-
In order to run the application locally, you need a .env file
-
Create (or copy from someone else in the team) the .env file in the kravbank-backend root directory:
DB_JDBC_URL = ""
DB_DATABASE = ""
DB_USER = ""
DB_PASSWORD = ""
KC_CRED_SECRET = ""
- Make sure you have added a SSH key to your GitHub settings to be able to clone the repository securely.
- Clone the repository
git clone [email protected]:dfo-no/krb-backend.git - Make sure you have installed Maven and Java 17 with relevant PATH environment variables. If you use
powershell you could install Java JDK/openJDK and Maven with Chocolatey
choco install openjdkchoco install maven - Launch application from CLI
quarkus dev - Launch application from IntelliJ Run kravbank-backend (Shift+F10)
- Kravbank API
- The API is deployed as an Azure App Service with github workflow pipelines
- Postgres instance for Kravbank
- The API uses a postgresql database, hosted as an Azure Database for PostgreSQL
-
Resources are secured by our keycloak server, deployed as an Azure App service
-
Keycloak is an OpenID Connect (OIDC) for Identity and access management (IAM)
-
The server is based on a docker container, spun up by a Keycloak docker image on Azure Container Registry (ACR):
krbkeycloakauth.azurecr.io
Instructions how to pull and push Docker images to ACR are I.e found on "Quick Start" in the Azure Portal resource
Credentials can be found under "Access Keys" in the Azure Portal resource
- Postgres instance for keycloak
- Keycloak uses an external database, hosted as an Azure Database for PostgreSQL
- We`re using Liquibase as the database tool for schema change management.
- ChangeLog.sql sequentially list all changes made to our database. It contains a record of all the changesets.
- To push an update to the database we need to use the update command Liquibase update docs.
- The bash script liquibaseUpdate.sh is found in project root. It enables the update command, based on the local environment variables.