update readme

This commit is contained in:
2025-04-10 12:03:37 +02:00
parent 4eb107d3ad
commit c35da4a043

View File

@@ -1,3 +1,43 @@
# lewangoalski
TODO: Readme z instrukcją instalacji venv'a z wymaganymi bibliotekami.
## 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
```