You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 8, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: documentation/documentation.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,10 +74,10 @@ Profile potencjalnych współlokatorów są sortowane według obliczonej w ten s
74
74
Deployment aplikacji realizowany w podejściu _Infrastructure as Code_ z użyciem kontenerów Dockerowych oraz platformy Render do hostowania backendu.
75
75
76
76
-**Eksport modeli REST do TypeScript**
77
-
Automatyczne generowanie typów TypeScript z modeli Kotlinowych w celu zapewnienia spójności danych między backendem a frontendem.
77
+
Automatyczne generowanie interface'ów TypeScript z modeli Kotlinowych w celu zapewnienia spójności danych między backendem a frontendem.
78
78
79
79
-**Swagger / OpenAPI**
80
-
Backend automatycznie generuje dokumentację API w formacie OpenAPI, udostępnianą w formie interaktywnego Swagger UI.
80
+
Dokumentacja API generowana jest za pomocą wtyczki do IntelliJ w formacie OpenAPI, a następnie udostępniana w formie interaktywnego Swagger UI.
81
81
82
82
-**Faker**
83
83
Biblioteka służąca do generowania losowych danych wykorzystywanych podczas testowania i developmentu.
@@ -97,6 +97,7 @@ Profile potencjalnych współlokatorów są sortowane według obliczonej w ten s
97
97
Narzędzie do generowania makiet UI i inspiracji wizualnych, które przyspieszyło proces projektowania interfejsu.
98
98
99
99
## Uruchamianie aplikacji
100
+
100
101
Przed rozpoczęciem upewnij się, że masz zainstalowany Docker oraz że usługa Docker Daemon jest uruchomiona. Szczegółowe instrukcje znajdziesz w oficjalnej dokumentacji: [Uruchamianie Docker Daemon](https://docs.docker.com/engine/daemon/start/).
101
102
102
103
#### Uruchamianie w kontenerach
@@ -217,7 +218,7 @@ src/
217
218
218
219
### `./main/kotlin/edu.agh.roomie`
219
220
220
-
Główny pakiet kodu źródłowego.
221
+
Główny pakiet kodu źródłowego.
221
222
222
223
-**Application.kt** – punkt wejścia aplikacji
223
224
-**Databases.kt** – konfiguruje bazę (H2 lokalnie, PostgreSQL w produkcji), zawiera funkcję do generowania danych testowych
Logika aplikacyjna została oddzielona od warstwy dostępu do danych i obsługi HTTP. Dzięki temu każda warstwa (serwisy, endpointy, modele) ma jasno określoną odpowiedzialność.
316
318
317
-
-**Dependency Injection**
319
+
-**Dependency Injection**
318
320
319
321
Wstrzykiwanie zależności do serwisów i warstwy HTTP odbywa się poprzez context receivers oraz ręczne przekazywanie instancji w `Dependencies.kt`, co ułatwia testowanie i modularność.
320
322
321
-
-**Strategia obliczania dopasowania**
323
+
-**Strategia obliczania dopasowania**
322
324
323
325
Funkcja `countScore.kt` realizuje strategię przypisywania wag i porównywania cech użytkowników. Dzięki enkapsulacji logiki oceny dopasowania w jednej funkcji łatwiej ją modyfikować lub rozszerzać.
Wdrożenie backendu oparte jest na kontenerach Docker i platformie Render. Podejście to zapewnia przenośność środowiska oraz spójność konfiguracji między lokalnym developmentem a produkcją.
0 commit comments