Steam Buddy

Design

1. Projekt
2. Makieta

Instrukcja uruchomienia projektu (środowisko developerskie)

Kroki do uruchomienia projektu

Aby uruchomić projekt, postępuj zgodnie z poniższymi krokami:

1. Zainstaluj Docker na swoim systemie.

2. Sklonuj repozytorium git

   git clone https://github.com/MRR-Group/steam-buddy.git

3. Otwórz terminal i przejdź do katalogu, w którym znajduje się plik docker-compose.yml.

4. Stwórz plik .env i dostosuj jego konfigurację.

   cp .env.example .env

5. Jeżeli używasz Linux'a, upewnij się że zmienna DOCKER_USER w .env zawiera poprawne id użytkownika i jego grupy. Unikniesz dzięki temu problemów z brakiem praw edycji do plików wygenerowanych przez artisan'a lub npm. Wartość DOCKER_USER powinna być równa wynikowi tej komendy:

   echo "$(id -u):$(id -g)"

   Jeżeli korzystasz z dokera dla Windowsa z WSL, pomiń ten krok, wartości 1000:1000 są dla ciebie poprawne.

6. Przygotuj aplikacje do pracy

   make init

7. Uruchom projekt:

   make dev

8. Po zakończeniu procesu uruchamiania, projekt będzie dostępny pod adresem http://localhost.

Dostęp do konsoli PHP w kontenerze

Aby uzyskać dostęp do konsoli PHP wewnątrz kontenera, wykonaj następujące kroki:

1. Otwórz terminal.
2. Uruchom poniższą komendę:

   make php

3. Teraz jesteś wewnątrz kontenera PHP i możesz korzystać z narzędzi, takich jak Composer.

Dostęp do konsoli NodeJS w kontenerze

Aby uzyskać dostęp do konsoli NodeJS wewnątrz kontenera, wykonaj następujące kroki:

1. Otwórz terminal.
2. Uruchom poniższą komendę:

   make node

3. Teraz jesteś wewnątrz kontenera Node i możesz korzystać z narzędzi, takich jak npm.

Uruchomienie Code style fixer'a dla PHP i JS:

1. Otwórz terminal.
2. Uruchom poniższą komendę:

   make fix

Uruchomienie Testów

1. Otwórz terminal.
2. Uruchom poniższą komendę:

   make test