From c35da4a043ea34e9cb3136910784f6aaecbbea4a Mon Sep 17 00:00:00 2001 From: sherl Date: Thu, 10 Apr 2025 12:03:37 +0200 Subject: [PATCH] update readme --- README.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f5a189..43727fb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ # lewangoalski -TODO: Readme z instrukcją instalacji venv'a z wymaganymi bibliotekami. \ No newline at end of file +## Uruchamianie projektu: +- Zacznij od pobrania plików projektu lub sklonuj repozytorium, używając git: +``` +git clone https://gitea.7o7.cx/roberteam/lewangoalski.git +``` + +- Przejdź do katalogu z plikami projektu: +``` +cd lewangoalski +``` + +- Stwórz wirtualne środowisko: +``` +python -m venv .venv +``` +Powyższe polecenie stworzy ukryty folder o nazwie *.venv*. + +- Aby aktywować to wirtualne środowisko należy użyć: + - na Linuxie (bash): + ``` + source .venv/bin/activate + ``` + - na Windowsie (cmd): + ``` + .venv\Scripts\activate + ``` + +- Zainstaluj niezbędne pakiety w świeżo utworzonym środowisku wirtualnym: +``` +pip3 install -r FlaskWebProject\requirements.txt +``` + +- Uruchom skrypt: + - w sposób ciągły: + ``` + python3 FlaskWebProject/runserver.py + ``` + - z automatycznym przeładowaniem (kod zostanie przeładowany po zmianie w bazie kodu): + ``` + flask --app FlaskWebProject/runserver run --debug + ``` \ No newline at end of file