System Rezerwacji Hotelowej¶
Witamy w dokumentacji systemu rezerwacji hotelowej — projektu stworzonego w ramach zajęć z inżynierii oprogramowania.
System umożliwia zarządzanie pokojami hotelowymi, gośćmi, rezerwacjami oraz płatnościami poprzez prosty interfejs tekstowy (CLI).
Dokumentacja zawiera opisy struktury projektu, klas danych, logiki działania oraz zestaw testów potwierdzających poprawność działania aplikacji.
Struktura dokumentacji¶
-
Klasy danych
Opis klas:Guest
,Room
,Reservation
,Hotel
iPayment
-
Logika aplikacyjna
Sposób działania systemu oraz powiązania między komponentami -
Interfejs użytkownika (CLI)
Przegląd dostępnych komend i interakcji z systemem -
Testy
Testy jednostkowe i integracyjne weryfikujące poprawność działania
Uruchomienie projektu¶
Upewnij się, że jesteś w katalogu głównym projektu i uruchom aplikację:
Technologie użyte w projekcie¶
- Python 3.12
- MkDocs + Material for MkDocs
unittest
– testowanie jednostkowe i integracyjnemkdocstrings
– automatyczna dokumentacja kodu
Dokumentacja opracowana przez grupę tworzącą projekt.