Skip to content
This repository was archived by the owner on Jun 8, 2025. It is now read-only.

Commit 536545d

Browse files
committed
minor fixes in documentation.md
1 parent 6f1e940 commit 536545d

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

documentation/documentation.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ Profile potencjalnych współlokatorów są sortowane według obliczonej w ten s
7474
Deployment aplikacji realizowany w podejściu _Infrastructure as Code_ z użyciem kontenerów Dockerowych oraz platformy Render do hostowania backendu.
7575

7676
- **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.
7878

7979
- **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.
8181

8282
- **Faker**
8383
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
9797
Narzędzie do generowania makiet UI i inspiracji wizualnych, które przyspieszyło proces projektowania interfejsu.
9898

9999
## Uruchamianie aplikacji
100+
100101
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/).
101102

102103
#### Uruchamianie w kontenerach
@@ -217,7 +218,7 @@ src/
217218

218219
### `./main/kotlin/edu.agh.roomie`
219220

220-
Główny pakiet kodu źródłowego.
221+
Główny pakiet kodu źródłowego.
221222

222223
- **Application.kt** – punkt wejścia aplikacji
223224
- **Databases.kt** – konfiguruje bazę (H2 lokalnie, PostgreSQL w produkcji), zawiera funkcję do generowania danych testowych
@@ -267,7 +268,7 @@ Logika biznesowa aplikacji, obsługa użytkowników, preferencji i dopasowań:
267268
- **InfoService.kt** - obsługuje operacje na tabeli InfosTable
268269
- **MatchService.kt** - zarządza zaproszeniami do dopasowania użytkowników
269270
- **PreferencesService.kt** - zarządza przechowywaniem preferencji użytkowników w PreferencesTable
270-
- **UserService.kt** - zarządza użytkownikami w tabeli UsersTable
271+
- **UserService.kt** - zarządza użytkownikami w tabeli UsersTable
271272

272273
### `./main/resources`
273274

@@ -310,15 +311,16 @@ Testy jednostkowe warstwy serwisów:
310311
- **UserServiceTest.kt**
311312

312313
### Zastosowane pomysły i wzorce projektowe
314+
313315
- **Separation of Concerns**
314-
316+
315317
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ść.
316318

317-
- **Dependency Injection**
319+
- **Dependency Injection**
318320

319321
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ść.
320322

321-
- **Strategia obliczania dopasowania**
323+
- **Strategia obliczania dopasowania**
322324

323325
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ć.
324326

@@ -330,7 +332,6 @@ Testy jednostkowe warstwy serwisów:
330332

331333
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ą.
332334

333-
334335
## Frontend
335336

336337
### Struktura projektu

0 commit comments

Comments
 (0)