Development Setup

Application Architecture

For local development start a keycloak container by following the steps below:

docker compose up keycloak -d

Open http://localhost:8081 and sign in with admin credentials
- Username: admin
- Password: admin
Click on the drowdown in the top left and go to Create realm
Import the keycloak-realm-config-example-json or create a new realm thesis-track manually.
Select the newly created realm and create your user in Users (username, email, first name, last name)
Go to "Credentials" for the new user and set a non temporary password
Go to "Role mapping" and assign the client roles admin, supervisor, advisor to the new user
- Select "Filter by clients" and search for "thesis-track-app" to find the roles

For local development start a database container by executing the following command from the project root:

docker compose up db -d

Notice: local development does not support mailing functionality. The mails are printed in the console when no postfix instance is configured.

Database available at jdbc:postgresql://db:5144/thesis-track
Keycloak realm thesis-track is available under http://localhost:8081 (See Keycloak Setup)

To start the sever application for local development, navigate to /server folder and execute the following command from the terminal:

./gradlew bootRun

Server running at http://localhost:8080
Keycloak realm thesis-track is available under http://localhost:8081 (See Keycloak Setup)

To start the client application for local development, navigate to /client folder and execute the following command from the terminal:

npm install
npm run dev