-updated readme -added function prepare_app.py

prepare_app.py

@@ -0,0 +1,4 @@
+import src.model.prepare_llm as prepare_llm
+
+prepare_llm.prepare_mistral()
+

readme.md

@@ -1,6 +1,26 @@
 System rekomendacyjny filmów dla opisu wyrażonego językiem naturalnym - "Filmosfera"
 
 Jak uruchomić?
-- python 3.12.7
-- pip install requirements.txt
-By zdobyć prawidłową listę filmów, scrappera należy uruchamiać z włączonym VPN na kraj anglojęzyczny.
+    - Wymagania przed uruchomieniem:
+      - Python <= 3.12.x
+      - Utworzenie wirtualnego środowiska Python by zapewnić zgodność dodatkowych bibliotek
+      - Z aktywowanego wirtualnego środowiska, z głównego katalogu projektu wywołać: pip install -r requirements.txt
+      - Następnie uruchomić skrypt prepare_app.py, który pobierze wymaganego do działania projektu LLM'a.
+    - Aby uruchomić Filmosferę w celu podpowiedzi filmowych:
+      - W katalogu głównym wywołać komendę python src/app/main.py
+      - Poczekać na uruchomienie się serwera
+      - Uruchomić stronę internetową w przeglądarce z podanego w terminalu adresu (domyślnie http://127.0.0.1:5000)
+  Samodzielne zdobycie oraz przygotowanie danych:
+      - Aby uruchomić część projektu związaną ze zdobyciem danych (folder /src/data_scrapper):
+        (Proces trwa ok. 10h ze względu na bardzo ostrożne podejście do rate limitów serwisu IMDB)
+        - Wymagania:
+          - uruchomiony VPN na kraj anglojęzyczny => IMDB automatycznie tłumaczy niektóre części stron oraz pokazuje polskie plakaty filmowe w przypadku polskiego IP
+        - Uruchomić z głównego katalogu "scrapper.py", zostanie utworzona baza filmowa Filmosfery
+        - Uruchomić z katalogu data_scrapper  "get_images", zostaną pobrane plakaty filmów, oraz baza filmowa zostanie zedytowana by je zawierać
+      - Preprocessing danych (folder process_data):
+        - należy uruchomić z katalogu process_data:
+          1. preprocess_data.py
+          2. make_actors_set.py
+          3. make_directors_set.py
+          4. make_genres_set.py
+      Dane są teraz gotowe do wykorzystania w Filmosferze.