From 33af290b80c1deb213080d9a8adbbc0a6c06e051 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20Gruszczy=C5=84ski?= Date: Thu, 3 Jul 2025 22:19:40 +0200 Subject: [PATCH] drobne zmiany i readme --- .env.example | 1 + README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++ docker-compose.yml | 1 + templates/base.html | 1 + templates/index.html | 2 +- templates/list.html | 4 +-- 6 files changed, 64 insertions(+), 3 deletions(-) create mode 100644 README.md diff --git a/.env.example b/.env.example index f2e1547..5628679 100644 --- a/.env.example +++ b/.env.example @@ -11,4 +11,5 @@ SYSTEM_PASSWORD=admin DEFAULT_ADMIN_USERNAME=admin DEFAULT_ADMIN_PASSWORD=admin123 +# Katalog wgrywanych plików UPLOAD_FOLDER=uploads \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..0fff30b --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# Live Lista Zakupów + +Aplikacja webowa do współdzielonych list zakupów z obsługą wielu użytkowników, trybem współpracy w czasie rzeczywistym, panelami administracyjnymi oraz możliwością załączania paragonów. + +## Funkcje + +- Tworzenie, edycja i archiwizacja list zakupów +- Dodawanie, edycja, usuwanie produktów i oznaczanie ich jako kupione +- Udostępnianie list przez link (token) +- Wgrywanie zdjęć paragonów do listy zakupów +- Wyszukiwarka produktów i podpowiedzi +- Komentarze do produktów +- Panel administracyjny (zarządzanie użytkownikami, listami, paragonami) +- Obsługa w czasie rzeczywistym (Socket.IO) +- Logowanie i autoryzacja użytkowników +- Systemowe hasło dostępu do aplikacji + +## Wymagania + +- Docker +- Docker Compose + +## Sposób uruchomienia z Docker Compose + +1. **Przygotuj plik `.env` w katalogu głównym projektu** (przykład): + +APP_PORT=8000 +SECRET_KEY=twoj_super_tajny_klucz +SYSTEM_PASSWORD=haslo_do_aplikacji +DEFAULT_ADMIN_USERNAME=admin +DEFAULT_ADMIN_PASSWORD=admin123 + +2. **Uruchom aplikację:** + +Domyślnie aplikacja będzie dostępna pod adresem: +**http://localhost:8000** + +3. **Pierwsze logowanie:** +- Po wejściu na stronę zostaniesz poproszony o podanie hasła systemowego (`SYSTEM_PASSWORD`). +- Przy pierwszym uruchomieniu zostanie automatycznie utworzone konto administratora na podstawie zmiennych `DEFAULT_ADMIN_USERNAME` i `DEFAULT_ADMIN_PASSWORD`. + +## Domyślne dane logowania + +- **Login administratora:** `admin` (lub wartość z `DEFAULT_ADMIN_USERNAME`) +- **Hasło administratora:** `admin123` (lub wartość z `DEFAULT_ADMIN_PASSWORD`) + +4. **Aby uruchomić aplikację w Dockerze, wykonaj następujące kroki:** + +## Przygotuj plik .env w katalogu projektu z wymaganymi zmiennymi środowiskowymi +## Upewnij się, że w katalogu projektu znajdują się pliki: +## Uruchom aplikację poleceniem: +docker compose up --build + +--- + +**Miłego korzystania z aplikacji!** + + diff --git a/docker-compose.yml b/docker-compose.yml index 1fb5e5b..980d468 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -11,5 +11,6 @@ services: - SYSTEM_PASSWORD=${SYSTEM_PASSWORD} - DEFAULT_ADMIN_USERNAME=${DEFAULT_ADMIN_USERNAME} - DEFAULT_ADMIN_PASSWORD=${DEFAULT_ADMIN_PASSWORD} + - UPLOAD_FOLDER=${UPLOAD_FOLDER} volumes: - .:/app diff --git a/templates/base.html b/templates/base.html index 7532065..574abc0 100644 --- a/templates/base.html +++ b/templates/base.html @@ -58,6 +58,7 @@ {% endwith %} }); + diff --git a/templates/index.html b/templates/index.html index 3cbfe16..b9234b6 100644 --- a/templates/index.html +++ b/templates/index.html @@ -50,7 +50,7 @@ {% endfor %} {% else %} -

Nie masz jeszcze żadnych list. Utwórz pierwszą, korzystając z formularza powyżej!

+

Nie masz jeszcze żadnych list. Utwórz pierwszą, korzystając z formularza powyżej!

{% endif %} {% endblock %} \ No newline at end of file diff --git a/templates/list.html b/templates/list.html index 5f3df70..ef5082f 100644 --- a/templates/list.html +++ b/templates/list.html @@ -73,8 +73,8 @@ {% else %}
-

Brak wgranych paragonów do tej listy.

-{% endif %} +

Brak wgranych paragonów do tej listy.

+ {% endif %}