How to start the project as a developer?

If you inspect main/resources/application.properties you can see that there are some variables used in the application. They are taken from environmental variables, but some of them have default values. Those that don't have default values have to be set by a developer. These are:

• SPRING_FLYWAY_USER - database username for flyway (most likely sa in develobpemnt environment)
• SPRING_FLYWAY_PASSWORD - database password for flyway
• SPRING_DATASOURCE_PASSWORD - database password
• SPRING_DATASOURCE_USER - database username for flyway (most likely sa in develobpemnt environment)
• SPRING_DATASOURCE_URL - database url (a connection string to your database)
• ADMIN_USER_PASSWORD - password for admin user that will be created on first application startup
• ALLOWED_ORIGINS - a comma-separated list of allowed origins for CORS (e.g. https://*.example.com,http://localhost:*). If not set, the application will allow all origins by default (*),
• ENABLE_SWAGGER - swagger is disabled by default. Set as true to access swagger documentation.
• JWT_KEY - key for jwt tokens generation
• JWT_EXPIRATION - days of jwt token lifetime

The best idea is to configure your IDE, so that it sets those variables always, when you run the application.

IntelliJ Idea instruction

To configure your IntelliJ Idea to the following:

• On the top mane open Run context menu
• Go to Debug -> Edit configurations -> Edit environmental variables
• Add proper variables with values and save changes

Documentation

• Remember to set ENABLE_SWAGGER environmental variable as true.
• Run this API
• Go to http://[host]:[port]/swagger-ui.html

Build docker image

You are able to build a docker image with this application simply by runnning

docker build -t your_image_name:your_tag .

The interenal docker image port, the applicatoin is listening on, is 8080.