readme update and add user instructions
This commit is contained in:
parent
020857a1e7
commit
811964e519
BIN
Podręcznik użytkowania.pdf
Normal file
BIN
Podręcznik użytkowania.pdf
Normal file
Binary file not shown.
21
README.md
21
README.md
@ -1,4 +1,4 @@
|
|||||||
# Analiza piłkarska z aplikacją `CoachStats`
|
# Aplikacja `CoachStats`
|
||||||
|
|
||||||
## Wstęp
|
## Wstęp
|
||||||
|
|
||||||
@ -9,21 +9,18 @@ CoachStats to innowacyjne narzędzie służące do analizowania statystyk Expect
|
|||||||
- **Analiza XG:** Analiza XG dla danej sytuacji meczowej.
|
- **Analiza XG:** Analiza XG dla danej sytuacji meczowej.
|
||||||
- **Personalizowana makieta:** Możliwość tworzenia własnej makiety odpowiadającej sytuacji meczowej.
|
- **Personalizowana makieta:** Możliwość tworzenia własnej makiety odpowiadającej sytuacji meczowej.
|
||||||
|
|
||||||
## Technologie
|
## Uruchomienie
|
||||||
|
|
||||||
## Instalacja i Uruchomienie
|
Aby uruchomić aktualną wersję aplikacji, wykonaj następujące kroki:
|
||||||
|
|
||||||
Aby uruchomić beta wersję aplikacji, wykonaj następujące kroki:
|
1. **Uruchomienie serwera:** Aby uruchomić serwer należy wejść w [link](https://sg-server-ne4h.onrender.com/) oraz zaczekać do pojawienia się komunikatu o błędzie 404. Aplikacja korzysta z darmowej wersji obsługi serwera, stąd sposób jego uruchomienia nie jest standardowy.
|
||||||
|
|
||||||
1. **Uruchomienie Klienta:**
|
|
||||||
Otwórz terminal w folderze `app` i uruchom następującą komendę:\
|
|
||||||
`npm run dev`
|
|
||||||
|
|
||||||
2. **Uruchomienie Serwera Flask:**
|
|
||||||
W innym terminalu, przejdź do folderu `app/src/flask-server` i uruchom serwer Flask przy użyciu poniższej komendy:\
|
|
||||||
`python server.py`
|
|
||||||
|
|
||||||
|
2. **Uruchomienie aplikacji webowej** Po wykonaiu kroku 1 można wejść na właściwą stronę [aplikacji](https://statgoals.onrender.com/).
|
||||||
|
|
||||||
## Dane
|
## Dane
|
||||||
|
|
||||||
- <https://statsbomb.com/what-we-do/soccer-data/>
|
- <https://statsbomb.com/what-we-do/soccer-data/>
|
||||||
|
|
||||||
|
## Szczegóły
|
||||||
|
|
||||||
|
Działanie aplikacji zostało opisane w podręczniku użytkownika znajdującym się w drzewie plików na repozytorium. Poza tym odsyłam do [repozytorium](https://git.wmi.amu.edu.pl/s478993/fantastyczne_gole) uniwersytetu na którym powstała aplikacja. Zawiera ono kod źródłowy aplikacji.
|
||||||
|
BIN
data/.DS_Store
vendored
BIN
data/.DS_Store
vendored
Binary file not shown.
Loading…
Reference in New Issue
Block a user