TrafficFlowOptimizer - moduł Backend

Opis

Moduł jest częścią serwerową aplikacji. Wszystkie inne komponenty komunikują się wyłącznie przez Backend. Użytkownik nie wchodzi z modułem bezpośrednio w interakcję - używa do tego Frontendu.

Wykorzystane zewnętrzne biblioteki

Moduł oparto na frameworku Spring i języku Java.
Plik pom.xml deklaruje pozostałe biblioteki oraz ich wersje (dependencies). Użytkownik budując projekt nie musi przejmować się ich instalacją, gdyż Maven zrobi to za niego automatycznie.

Jak uruchomić moduł

Backend można uruchomić na dwa sposoby: lokalnie lub na Dockerze. Jednak w wersji zwirtualizowanej OpenCV nie działa poprawnie i z tego powodu nie jest zwracana pierwsza klatka przesyłanego nagrania. Dlatego zaleca się uruchamianie lokalnie, które działa całkowicie poprawnie.

Za pomocą Dockera

Wymagania:

• zainstalowany Docker
• zainstalowane narzędzie Docker Compose
• uruchomiona Baza Danych

jeśli uruchamiasz Optymalizator lokalnie (nie za pomocą Dockera) należy zmienić wartość zmiennej OPTIMIZER_HOST w pliku docker compose na host.docker.internal

Instrukcja:

• uruchomić Dockera
• w katalogu projektu: docker compose up

Za pomocą Mavena

Wymagania:

• zainstalowana Java 17
• zainstalowany Maven
• uruchomiona Baza Danych

Instrukcja:

• katalog projektu należy otworzyć w ulubionym IDE (przykładowo IntelliJ Idea)
• wybudować projekt za pomocą Mavena
• uruchomić aplikację z konfiguracją używającą zmiennych z pliku .env (w Idea można użyć do tego plugin)

Dokumentacja

• Dokumentacja Springa
• Dokumentacja Testcontainers
• Dokumentacja Dockera