Skip to content

Backend documentation

Technical stack

  • Language: java
  • Framework: Quarkus
  • Database: PostgreSQL

Requirements

  • Java 21 (AWS Corretto for example)
  • Docker or Podman
  • Maven

Source code repository

Continuous Integration

I decided to use Github actions, source code of CI is inside repository. You can observe Github actions threw this link

Installation for development

Maven and Java

You can use SDKMAN to install Java and Maven: https://sdkman.io/

Docker or Podman

You can install Docker using the following link: https://docs.docker.com/get-docker/ You can install Podman using the following link: https://podman.io

PostgreSQL

Use docker to run a PostgreSQL instance:

docker run -it --rm=true --name quarkus_test -e POSTGRES_USER=quarkus_test -e POSTGRES_PASSWORD=quarkus_test -e POSTGRES_DB=quarkus_test -p 5432:5432 postgres:13.3

Swagger