README.pl.md

party-games-platform

Internetowa platforma umożliwiająca tworzenie, przeglądanie oraz granie w gry przeglądarkowe. Umożliwia rozgrywkę wielu użytkownikom naraz w czasie rzeczywistym dzięki wykorzystaniu pokojów WebSocketowych.

Cechy

• Interaktywny kreator gier oparty na grafach stworzony przy użyciu biblioteki ReactFlow
• Dołączanie do pokoju gry na podstawie automatycznie wygenerowanego kodu PIN
• Rejestracja oraz logowanie
• Możliwość gry anonimowej
• Konfigurowalne elementy z ustawieniami domyślnymi (poziomy, przeciwnicy, przedmioty)
• Opcja tworzenia oraz grania w proste quizy

Technologie

• Backend

  • Java Spring Boot 3
  • Websockets
  • MongoDB
  • Redis

• Frontend

  • ReactJS
  • Tailwind
  • Websockets
  • Vite

Instalacja

Zalecaną opcją instalacji projektu jest użycie narzędzia docker compose.

Wymagania wstępne

• Użytkownik musi mieć możliwość uruchamiania poleceń docker (bezpośrednio lub przez sudo).
• Musisz mieć zainstalowaną aplikację docker compose.
• Użytkownik musi mieć możliwość zmiany uprawnień do plików (bezpośrednio lub przez sudo).

Kroki

• Utworzyć plik .env w katalogu głównym projektu oraz zdefiniować wymagane zmienne. Jako szablon może posłużyć plik .env-example

• Uruchomić projekt za pomocą komendy:

docker compose up -d

---

Współtwórcy