ANYMARKET_API

Wymagania wstępne

1. Zainstaluj środowisko Docker

Konfiguracja zmiennych środowiskowych

1. Przejdź do głównej lokacji projektu
2. Utwórz kopię pliku .env.example pod nazwą .env

cp .env.example .env

3. Wgraj plik konfiguracji Firebase do projektu. Docelowo powinien znaleźć się w lokacji /storage

4. Otwórz plik .env i uzupełnij zmienną FIREBASE_CREDENTIALS odpowiednią wartością, tj. ścieżką do konfiguracji Firebase

Budowanie obrazu Docker

Będąc w głównym folderze aplikacji, zbuduj obraz dockera i uruchom aplikację wykonując odpowiednie komendy:

docker compose build
docker compose up -d

Konfiguracja Laravel

Po zbudowaniu obrazu konieczna jest jeszcze konfiguracja samego projektu w Laravel. W tym celu konieczne jest wykonanie pewnych komend w obrębie zbudowanego kontenera w Dockerze

1. Przejdź do trybu wykonywania komend wewnątrz kontenera:

docker exec -it anymarket_api sh

2. Wewnątrz tego trybu wprowadz kolejne komendy, każdą pojedyńczo:

php artisan key:generate
php artisan migrate:fresh --seed

3. Po wykonaniu powyższych komend, wyjdź z trybu docker exec:

exit

---

Instrukcje wpisywane w trybie docker exec można równie dobrze wykonać za pomocą klienta Docker, w wersji GUI

---

Po wykonaniu wszystkich kroków możesz zweryfikować, czy aplikacja poprawnie się uruchomiła. W tym celu otwórz w przeglądarce adres: http://127.0.0.1:8050/

Jeżeli aplikacja nie jest dostępna, można zresetować kontenery Docker-a i sprawdzić jeszcze raz. Aby zresetować wszystkie kontenery wykonaj komendę lub kliknij odpowiedni przycisk w GUI:

docker compose restart

---

Dane testowe

Po udanym skonfigurowaniu i uruchomieniu aplikacji, automatycznie tworzone są dane testowe. Dostępne będzie także konto użytkownika, na które należy zalogować się w aplikacji mobilnej ANYMARKET:

• email: test@example.com
• hasło: password

---

Dodatkowe komendy

W projekcie zaimplementowano komendy ułatwiające zarządzanie webscrap-jobami. Można wykonywać je w trakcie działania aplikacji, aby umożliwić aplikacji mobilnej pobieranie cen z zaktualizowanego już źródła

• webscrap:clear - pozwala wyczyścić niedokończone zlecenia
• webscrap:reset - pozwala wyczyścić statystki źródeł cen

Przykład użycia wewnątrz docker exec:

php artisan webscrap:clear
php artisan webscrap:reset