tile3rubric/rubric-service repository overview

⁠Readme

⁠1. beschrijving

Dit is de backend service voor het project 'Rubric' ontwikkeld in het kader van TILE3 / project mobile apps.

⁠2. project info

Dit is een Spring Boot 2.1.8 applicatie met Java 11 en gradle.

⁠3. gebruik

2 mogelijkheden: 1. open het project in een IDE, compileer en 'run' met profile local 2. deploy met docker (aant te raden als je enkel de service nodig hebt om api calls te doen)

⁠gebruik met docker

Met docker zit alles wat de service nodig heeft in de docker 'container'. Alle dependencies zitten mee verpakt in de docker image, daardoor kan je platform-onafhankelijk de service deployen, of je deze nu op je pc (lokaal) start, of in de cloud.

De enige vereiste is dat je docker installeert⁠. Wie niet wil registreren bij docker kan ook de installers rechtstreeks downloaden⁠.

De service opstarten is dan 1 enkel commando:

docker run -p 8080:8080 --name rubric-service chaixdev/rubric-service:latest

Er zit in de root directory ook een bash script (linux) startRubricService.sh, die je gemakkelijk in staat stelt om de service te herstarten.

docker stop rubric-service
docker remove rubric-service
docker pull chaixdev/rubric-service:latest
docker run \
--name rubric-service \
-p 8080:8080 \
-e "SPRING_PROFILES_ACTIVE=local" \
chaixdev/rubric-service:latest

parameters:

• --name rubric-service geeft de container een naam.
• -p 8080:8080 zorgt voor binding tussen de host poort (dus http://localhost:8080⁠) en de container poort 8080
• -e "SPRING_PROFILES_ACTIVE=local" zal de juiste properties inladen om lokaal te draaien.
• chaixdev/rubric-service verwijst naar de docker hub repository waar de laatste x.x.x-RELEASE versies van de service beschikbaar zullen zijn.
• :latest vertelt aan docker welke versie van de service die op docker hub staat we willen gebruiken

⁠gebruik H2 database

De database zal bij het lokaal testen beschikbaar zijn via de url: localhost:8080/h2-console De gebruikersnaam en wachtwoord zijn default, maar zijn ook te vinden in: application-local.properties Bij het het H2 login scherm, moet ook de JDBC URL aangepast worden naar : jdbc:h2:mem:testdb;DB_CLOSE_ON_EXIT=FALSE

⁠Genereren mock data

Het bestand data.sql onder resources wordt uitgevoerd bij het opstarten van de applicatie. Hierin kunnen queries geplaatst worden voor het initialiseren van de database.