Foliand - Wkład użytkownika [pl]

IPWA:Instalacja/Docker

2026-04-28T07:49:07Z

Slasherss: /* Compose */ Nowy link

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Aktualnie wspierana jest instalacja programu jako kontenera Docker.

== Instalacja Docker ==
Jeśli Docker jeszcze nie jest zainstalowany, należy postępować zgodnie z instrukcją na oficjalnej stronie Docker - [https://docs.docker.com/get-started/get-docker/ Get Docker (en)]

===Compose===
Aby zainstalować program, należy pobrać [https://git.foliand.men/slasherss/ipwa kod źródłowy]. Repozytorium zawiera plik <code>.env.template</code>. Na podstawie pliku należy utworzyć plik <code>.env</code> i zmienić wartości zmiennych:
*<code>DOMAIN=</code> Nazwa domeny na której będzie aplikacja (np. ''ipwa.foliand.men''). Docelowo aplikacja jest na ścieżce <code>/ipwa</code> oraz szuka serwera na ścieżce <code>/api</code>.
*<code>EMAIL=</code> Email administratora. Jest on konieczny do uzyskania certyfikatu ssl. ''(Planowane jest usunięcie tej funkcji, aby uzyskać certyfikat będzie należało użyć innej aplikacji)''
*<code>SECRET=</code> Należy wprowadzić dowolny ciąg znaków. Ważne, aby nikt nie uzyskał do niego dostępu.
Gdy wszystkie zmienne zostały już ustawione system jest gotowy do rozruchu.

Aby uruchomić system, należy wpisać polecenie <code>docker compose up -d</code>.

===Pierwsze kroki===
Najlepiej zacząć od [[IPWA:Tworzenie konta administratora|utworzenia konta administratora]].

IPWA:Start

2026-04-28T07:44:51Z

Slasherss: /* Źródło */ Nowy link

'''IPWA''' (Internat [https://pl.wikipedia.org/wiki/Progressive_web_app Progressive web application]) to projekt zapoczątkowany 16 Maja 2023 w [https://internat.zsgh.torun.pl/ Internacie ZSGH w Toruniu]. Jego głownym celem jest cyfryzacja procesów zachodzących w internatach. Projekt stawia na wygodę i prostotę obsługi, aby ułatwić codzienne funkcjonowanie.

==Dokumentacja==

===Instalacja===
Instrukcja instalacji dla administratorów:
*[[IPWA:Instalacja/Docker|Docker]]

===Wprowadzenie===
*[[IPWA:Tworzenie konta administratora|Tworzenie konta administratora]]
*[[IPWA:Konfiguracja|Konfiguracja]]
*[[IPWA:Zarządzanie użytkownikami|Zarządzanie użytkownikami]]
* [[IPWA:Wskazówki dot. treści|Wskazówki dot. treści]]

===Moduły===
*[[IPWA:Wiadomości|Wiadomości]]
*[[IPWA:Jadłospis|Jadłospis]]
*[[IPWA:Powiadomienia|Powiadomienia]]
*[[IPWA:Grupy|Grupy]]
*[[IPWA:Czystość|Czystość]]
*[[IPWA:Klucze|Klucze]]

===Źródło===
<s>Kod źródłowy aplikacji jest podzielony na dwie części i jest dostępny w serwisie Github:</s>
*<s>[https://github.com/Slasherss1/ipwa Frontend] - Odpowiada za warstwę widoczną dla użytkownika.</s>
*<s>[https://github.com/Slasherss1/ipwa-backend Backend] - Odpowiada za logikę i dane aplikacji.</s>
Kod został połączony i od teraz jest dostępny w całości pod adresem https://git.foliand.men/slasherss/ipwa

===Licencja===

Program dozwolony do użytku na warunkach licencji [https://www.gnu.org/licenses/gpl-3.0-standalone.html GPL-3.0].

__BEZSPISU__
__BEZEDYCJISEKCJI__

IPWA:Czystość

2026-04-26T21:40:45Z

Slasherss: Dodano breadcrumb

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Moduł ten służy do monitorowania porządku w pokojach wychowanków. Pozwala na standaryzację oceniania oraz zapewnia wychowankom szybki dostęp do informacji zwrotnej na temat stanu ich pokoju.

== Widok użytkownika ==
Użytkownicy mają stały dostęp do swoich wyników, co sprzyja utrzymywaniu standardów czystości. Ocena jest widoczna dla użytkownika w zakładce '''"Konto"'''. Po kliknięciu w przycisk '''"Ocena za czystość"''', użytkownik widzi listę kategorii, które zostały zaznaczone podczas obchodu, oraz ewentualne notatki wychowawcy. Pozwala to na precyzyjne określenie, co wymaga poprawy.

== Przeprowadzanie obchodu ==
Ocenę wystawia wychowawca (administrator z uprawnieniem "Czystość") w trakcie obchodu pokoi. Proces ten odbywa się w czasie rzeczywistym poprzez panel administracyjny. Lista pokoi generowana jest automatycznie na podstawie danych zawartych w [[IPWA:Konfiguracja#Pokoje|konfiguracji]].

=== System oceniania: ===
*Bazową oceną dla każdego pokoju jest '''6'''.
*Każde zaznaczenie kategorii (np. „niepościelone łóżko”) obniża ocenę końcową o '''1 stopień'''.
*Tę samą kategorię można zaznaczyć wielokrotnie, jeśli uchybienie dotyczy np. kilku łóżek w pokoju.
*Minimalna możliwa ocena do wystawienia to '''1'''.
*Dostępne jest też otwarte pole na notatki. Są one widoczne dla wychowanków.

=== Obecność i notatki: ===
Jeśli w trakcie obchodu wychowawca nie może przeprowadzić kontroli, może zapisać obecność wychowanka i godzinę jego wyjścia. Pozwala to na oznaczenie pokoi, do których należy wrócić o późniejszej godzinie. Po przejściu do sekcji '''"Pokoje do sprawdzenia"''' można zobaczyć listę pokoi w których zostały zaznaczone godziny wyjścia. Dodatkowo dostępny jest formularz notatek, który może być przydatny w szczególnych przypadkach (np. chory wychowanek pozostający w pokoju).

Lista obecności i notatki są automatycznie czyszczona każdego dnia o godzinie 00:00.

== Raportowanie i statystyki ==
System archiwizuje wszystkie oceny wystawione danego dnia. Administrator ma możliwość analizy średniej ocen dla poszczególnych pokoi w danym zakresie dat, co ułatwia wyłanianie najlepiej ocenianych pokoi.

IPWA:Czystość

2026-04-26T21:40:04Z

Slasherss: Utworzono stronę

Moduł ten służy do monitorowania porządku w pokojach wychowanków. Pozwala na standaryzację oceniania oraz zapewnia wychowankom szybki dostęp do informacji zwrotnej na temat stanu ich pokoju.

== Widok użytkownika ==
Użytkownicy mają stały dostęp do swoich wyników, co sprzyja utrzymywaniu standardów czystości. Ocena jest widoczna dla użytkownika w zakładce '''"Konto"'''. Po kliknięciu w przycisk '''"Ocena za czystość"''', użytkownik widzi listę kategorii, które zostały zaznaczone podczas obchodu, oraz ewentualne notatki wychowawcy. Pozwala to na precyzyjne określenie, co wymaga poprawy.

== Przeprowadzanie obchodu ==
Ocenę wystawia wychowawca (administrator z uprawnieniem "Czystość") w trakcie obchodu pokoi. Proces ten odbywa się w czasie rzeczywistym poprzez panel administracyjny. Lista pokoi generowana jest automatycznie na podstawie danych zawartych w [[IPWA:Konfiguracja#Pokoje|konfiguracji]].

=== System oceniania: ===
*Bazową oceną dla każdego pokoju jest '''6'''.
*Każde zaznaczenie kategorii (np. „niepościelone łóżko”) obniża ocenę końcową o '''1 stopień'''.
*Tę samą kategorię można zaznaczyć wielokrotnie, jeśli uchybienie dotyczy np. kilku łóżek w pokoju.
*Minimalna możliwa ocena do wystawienia to '''1'''.
*Dostępne jest też otwarte pole na notatki. Są one widoczne dla wychowanków.

=== Obecność i notatki: ===
Jeśli w trakcie obchodu wychowawca nie może przeprowadzić kontroli, może zapisać obecność wychowanka i godzinę jego wyjścia. Pozwala to na oznaczenie pokoi, do których należy wrócić o późniejszej godzinie. Po przejściu do sekcji '''"Pokoje do sprawdzenia"''' można zobaczyć listę pokoi w których zostały zaznaczone godziny wyjścia. Dodatkowo dostępny jest formularz notatek, który może być przydatny w szczególnych przypadkach (np. chory wychowanek pozostający w pokoju).

Lista obecności i notatki są automatycznie czyszczona każdego dnia o godzinie 00:00.

== Raportowanie i statystyki ==
System archiwizuje wszystkie oceny wystawione danego dnia. Administrator ma możliwość analizy średniej ocen dla poszczególnych pokoi w danym zakresie dat, co ułatwia wyłanianie najlepiej ocenianych pokoi.

IPWA:Klucze

2026-04-26T20:59:33Z

Slasherss: Utworzono artykuł

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>Moduł '''Klucze''' służy do ewidencjonowania obiegu kluczy do sal w obiekcie. Pozwala na szybkie sprawdzenie dostępności pomieszczeń oraz prowadzenie cyfrowego dziennika wypożyczeń.

Proces wypożyczania opiera się na ścisłej współpracy użytkownika z administratorem:
*Fizyczne wydanie i zwrot klucza odbywa się u administratora z uprawnieniem "Klucze".
*Użytkownik ma wgląd w aktualny status sal (wolna/zajęta), co pozwala na planowanie działań bez konieczności podchodzenia do dyżurki.
*Lista dostępnych sal jest pobierana automatycznie z [[IPWA:Konfiguracja#Sale z kluczami|konfiguracji systemu]].
==Dziennik wypożyczeń==
Administrator posiada pełny wgląd w historię obiegu kluczy. Domyślnie widoczne są tylko aktualnie wypożyczone klucze (ułatwia to szybką kontrolę, które kluczę są wypożyczone).

Aby wyświetlić pełną historię wypożyczeń, należy kliknąć przycisk '''"Pokaż wszystko"'''.
==Rejestracja wypożyczenia==
Wydanie klucza rejestruje administrator w sekcji "Klucze". Aby dodać nowy wpis:
#Należy wybrać użytkownika z wyszukiwarki.
#Należy wybrać salę z listy dostępnych pomieszczeń.
#Po zatwierdzeniu sala zmienia status na '''zajętą''', a informacja o tym jest natychmiast widoczna dla wszystkich użytkowników systemu.
==Zwrot klucza==
W momencie fizycznego oddania klucza, administrator musi odnotować ten fakt w systemie:
*W widoku aktualnych wypożyczeń, przy odpowiednim wpisie, należy kliknąć przycisk zwrotu klucza.
*Opcja ta jest widoczna wyłącznie przy pozycjach, które nie zostały jeszcze rozliczone.
*Po kliknięciu sala automatycznie staje się ponownie '''wolna'''.

IPWA:Grupy

2026-04-26T20:37:06Z

Slasherss: /* Tworzenie grup */ Utworzono sekcję

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Moduł grup umożliwia tworzenie grup, które można [[IPWA:Zarządzanie użytkownikami#Karta użytkownika|przypisywać użytkownikom]]. Funkcjonalność ta jest przydatna podczas wysyłania [[IPWA:Powiadomienia|powiadomień]].

== Tworzenie grup ==
Aby dodać grupę, należy przejść do zakładki '''"Grupy"''' w Panelu Administracyjnym. Po kliknięciu "Nowa grupa" system zapyta nas o nazwę nowej grupy.

Po utworzeniu można przypisać grupę użytkownikom w sekcji [[IPWA:Zarządzanie użytkownikami|Zarządzanie kontami]].

IPWA:Powiadomienia

2026-04-26T19:48:04Z

Slasherss:

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Moduł powiadomień służy do bezpośredniej komunikacji z użytkownikami systemu. Pozwala na przekazywanie ważnych komunikatów dotyczących zmian organizacyjnych lub ogłoszeń administracyjnych.

==Wysyłanie powiadomień==
Możliwość wysyłania powiadomień posiadają wyłącznie administratorzy z odpowiednimi uprawnieniami. Funkcja ta dostępna jest w '''Panelu Administracyjnym''' w zakładce '''Wysyłanie powiadomień'''.

===Formularz wysyłki===
Aby wysłać nową wiadomość, należy uzupełnić następujące pola:
*'''Odbiorca''' – system pozwala na precyzyjne określenie adresatów. Można wybrać:
**Pojedynczego użytkownika,
**Cały pokój (wszyscy przypisani do niego użytkownicy),
**Grupę (np. uczniowie, Grupa #, konkretna dieta).
*'''Tytuł''' – krótki nagłówek, który wyświetli się w powiadomieniu Push oraz w powiadomieniu w aplikacji.
*'''Zawartość wiadomości''' – pełna treść komunikatu.

Po kliknięciu przycisku '''"Wyślij"''', wiadomość jest natychmiast przekazywana do systemów dostarczania.
*'''Uwaga:''' Operacji wysyłania nie można cofnąć. Przed zatwierdzeniem upewnij się, że treść wiadomości oraz lista odbiorców są poprawne.
==Odbiór powiadomień przez użytkownika==
System dostarcza wiadomości dwoma kanałami:

# '''Push''' – Jeśli użytkownik wyraził zgodę w swojej przeglądarce, powiadomienie pojawi się bezpośrednio na pulpicie komputera lub ekranie telefonu, nawet jeśli aplikacja nie jest w danej chwili aktywna.
# '''Wewnątrz aplikacji''' – Po zalogowaniu się, użytkownikowi zostaną wyświetlone wszystkie nowe powiadomienia w formie okienek.

===Potwierdzenie odczytu===
Każde powiadomienie wewnątrz aplikacji zawiera przycisk '''potwierdzający odczytanie'''. Kliknięcie go jest niezbędne, aby wiadomość przestała się wyświetlać.

'''Uwaga:''' Obecnie potwierdzenie służy jedynie do ukrywania powiadomienia u użytkownika. Administratorzy nie mają jeszcze wglądu w statystyki odczytów ''(funkcja planowana)''.
==Historia wiadomości==
Wszystkie komunikaty wysłane przez administratora są archiwizowane w sekcji '''"Wysłane"'''. Można tam sprawdzić historię komunikacji, datę wysyłki oraz listę osób lub grup, do których skierowano daną informację.

IPWA:Powiadomienia

2026-04-26T19:47:21Z

Slasherss: Utworzono artykuł

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Moduł powiadomień służy do bezpośredniej komunikacji z użytkownikami systemu. Pozwala na przekazywanie ważnych komunikatów dotyczących zmian organizacyjnych lub ogłoszeń administracyjnych.

==Wysyłanie powiadomień==
Możliwość wysyłania powiadomień posiadają wyłącznie administratorzy z odpowiednimi uprawnieniami. Funkcja ta dostępna jest w **Panelu Administracyjnym** w zakładce **Wysyłanie powiadomień**.

===Formularz wysyłki===
Aby wysłać nową wiadomość, należy uzupełnić następujące pola:
*'''Odbiorca''' – system pozwala na precyzyjne określenie adresatów. Można wybrać:
**Pojedynczego użytkownika,
**Cały pokój (wszyscy przypisani do niego użytkownicy),
**Grupę (np. uczniowie, Grupa #, konkretna dieta).
*'''Tytuł''' – krótki nagłówek, który wyświetli się w powiadomieniu Push oraz w powiadomieniu w aplikacji.
*'''Zawartość wiadomości''' – pełna treść komunikatu.

Po kliknięciu przycisku '''"Wyślij"''', wiadomość jest natychmiast przekazywana do systemów dostarczania.
*'''Uwaga:''' Operacji wysyłania nie można cofnąć. Przed zatwierdzeniem upewnij się, że treść wiadomości oraz lista odbiorców są poprawne.
==Odbiór powiadomień przez użytkownika==
System dostarcza wiadomości dwoma kanałami:

# '''Push''' – Jeśli użytkownik wyraził zgodę w swojej przeglądarce, powiadomienie pojawi się bezpośrednio na pulpicie komputera lub ekranie telefonu, nawet jeśli aplikacja nie jest w danej chwili aktywna.
# '''Wewnątrz aplikacji''' – Po zalogowaniu się, użytkownikowi zostaną wyświetlone wszystkie nowe powiadomienia w formie okienek.

===Potwierdzenie odczytu===
Każde powiadomienie wewnątrz aplikacji zawiera przycisk '''potwierdzający odczytanie'''. Kliknięcie go jest niezbędne, aby wiadomość przestała się wyświetlać.

'''Uwaga:''' Obecnie potwierdzenie służy jedynie do ukrywania powiadomienia u użytkownika. Administratorzy nie mają jeszcze wglądu w statystyki odczytów ''(funkcja planowana)''.
==Historia wiadomości==
Wszystkie komunikaty wysłane przez administratora są archiwizowane w sekcji '''"Wysłane"'''. Można tam sprawdzić historię komunikacji, datę wysyłki oraz listę osób lub grup, do których skierowano daną informację.

IPWA:Jadłospis

2026-04-26T10:24:54Z

Slasherss: /* Zbieranie opinii */ Uzupełniono sekcję

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Moduł ten pozwala na sprawne zarządzanie menu oraz jego atrakcyjną prezentację. Składa się z zaawansowanego edytora, przejrzystego widoku dla odbiorców oraz systemu oceniania poszczególnych dań.

== Układanie jadłospisu ==
===Wybór tygodnia===
W wyszukiwarce należy wybrać zakres dat. Można zrobić to ręcznie poprzez wpisanie daty lub przez wybieracz dat (ikona kalendarza na końcu pola daty). Po wybraniu lub wpisaniu daty należy kliknąć ikonę wyszukiwania (🔍). System wyświetli wszystkie pasujące wpisy jadłospisu. '''Jeśli system nie zwróci wyników''', oznacza to, że nie zostały dodane żadne wpisy ([[#Dodawanie wpisów dnia]]).

===Dodawanie wpisów dnia ===
Aby dodać wpis w jadłospisie, należy kliknąć przycisk '''"dodaj" (+)''' na górnym pasku. System wyświetli okno pytające, w jaki sposób należy utworzyć wpisy. Do wyboru są dostępne opcje:

* Dzień – Dodawanie pojedynczego wpisu,
* Tydzień – Dodawanie pięciu wpisów dla wybranego tygodnia
* '''''Uwaga:''''' ''Nie należy używać opcji plik. Jest to funkcjonalność ze wcześniejszych wersji programu. Aktualnie może to powodować błędy w działaniu programu. Opcja zostanie usunięta w przyszłej wersji programu.''

===Wpisywanie pozycji===
[[Plik:IPWA Jadłospis wpis pusty.png|bezramki|1611x1611px]]

Każdy wpis jadłospisu dzieli się na cztery kolumny:

* '''Nagłówek''' zawierający datę, dzień tygodnia, opcjonalną nazwę dnia (np. "Wigilia") oraz przycisk usuwania całego wpisu,
* '''Śniadanie''' zawierające pozycje domyślne (do ustawienia w [[IPWA:Konfiguracja|konfiguracji]] przez administratora), pozostałe pozycje oraz drugie śniadanie,
*'''Obiad''' zawierający zupę, danie główne (w wersji standardowej oraz wegetariańskiej), dodatki (np. ziemniaki, surówki), napój oraz miejsce na dodatkowe wpisy,
*'''Kolacja''' zawierająca pozycje domyślne (do ustawienia w konfiguracji) oraz danie kolacyjne.

Wszystkie wpisy są edytowalne przez kliknięcie na nie. Dodatkowo, wpisy w ramce to listy, kliknięcie na nie uruchamia edytor listy.

Ważne, aby dania znajdowały się w odpowiednich polach, ponieważ później podczas oceniania, użytkownik będzie widział odpowiednie opcje oceny dania.

W programie jest zawarta domyślna lista alergenów: (''Planowana funkcja: Możliwość zmiany listy)''

# Nabiał
# Gluten
# Seler
# Jaja
# Ryby
# Sezam / Orzechy

===Wydruk===
Aby wydrukować jadłospis, należy wybrać interesujący nas tydzień, a następnie kliknąć ikonę "Drukuj" (🖨️). System pokaże okno drukowania.

==Zbieranie opinii==
System umożliwia zbieranie szczegółowych informacji zwrotnych od użytkowników na temat serwowanych posiłków. Pozwala to na monitorowanie jakości potraw oraz lepsze dostosowanie przyszłych jadłospisów do preferencji odbiorców.

=== Głosowanie przez użytkownika ===
Użytkownik przeglądający jadłospis może ocenić każdy z trzech głównych posiłków (śniadanie, obiad, kolacja).

Przy każdym posiłku znajduje się '''ikona gwiazdki'''. Jej kliknięcie otwiera panel oceniania.

W panelu użytkownik może ocenić każdy element składowy posiłku (np. osobno zupę, osobno danie główne) za pomocą:

* '''Gwiazdek''' – ogólna ocena satysfakcji,
* '''Tagów''' – szybkie przyciski wyboru (np. „za słone”, „bardzo smaczne”), które są automatycznie dopasowane do kategorii dania (zupy, dodatki itp.),
* '''Pola tekstowego''' – miejsce na szczegółowy komentarz (np. uwagi dotyczące temperatury dania lub sugestie zmian).

Każdy zalogowany użytkownik może wystawić opinię dla danego posiłku w konkretnym dniu. System pozwala na '''edycję wystawionej wcześniej opinii''' w dowolnym momencie.

=== Analiza wyników ===
Administratorzy mogą przeglądać zgromadzone opinie bezpośrednio w widoku zarządzania jadłospisem. Aby to zrobić, należy przejść do sekcji '''"Badanie opinii".'''

[[Plik:IPWA Badanie opinii.png|bezramki|940x940px]]

Po wybraniu zakresu dat, kliknięcie w dowolną pozycję jadłospisu w danym dniu wyświetla szczegółowe zestawienie, które zawiera:

* Średnią ocenę gwiazdkową,
* Statystykę najczęściej wybieranych tagów,
* Listę wszystkich opinii tekstowych pozostawionych przez użytkowników.

Plik:IPWA Badanie opinii.png

2026-04-26T10:13:34Z

Slasherss:

IPWA:Jadłospis

2026-04-19T10:34:55Z

Slasherss: /* Wpisywanie pozycji */ Rozbudowano sekcję

IPWA:Jadłospis

2026-04-19T09:23:14Z

Slasherss: Zmieniono słownictwo

IPWA:Jadłospis

2026-04-18T17:59:31Z

Slasherss: /* Wydruk */ Poprawiono sekcję

IPWA:Jadłospis

2026-04-18T17:56:30Z

Slasherss: Rozbudowano sekcje

Plik:IPWA Jadłospis wpis pusty.png

2026-04-18T17:47:15Z

Slasherss:

zdj

IPWA:Tworzenie konta administratora

2026-04-18T14:05:55Z

Slasherss: Zmieniono słownictwo

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Aktualnie nie została utworzona procedura tworzenia konta. Aby utworzyć konto należy bezpośrednio połączyć się do bazy danych.

== Mongosh==
[https://www.mongodb.com/docs/mongodb-shell/ Mongosh] to narzędzie do manipulacji bazą danych bezpośrednio z wiersza poleceń.

Aby utworzyć konto należy uruchomić program terminala i wpisać polecenie <code>mongosh</code>

Następnie wybrać bazę danych

<source>use ipwa</source>

i utworzyć użytkownika (hasło można wygenerować przy pomocy stron takich jak https://bcrypt.online/)
<source>db.logins.insertOne({
uname: 'NAZWA UŻYTKOWNIKA',
pass: 'SZYFROWANE HASŁO',
admin: 255
})</source>
następnie można zalogować się w aplikacji przy pomocy wcześniej wpisanych danych. Po zalogowaniu można przejść dalej do [[IPWA:Konfiguracja|Konfiguracji]].

==MongoDB Compass==
{{STUB}}

IPWA:Instalacja/Docker

2026-04-18T14:00:15Z

Slasherss: Zmieniono słownictwo

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Aktualnie wspierana jest instalacja programu jako kontenera Docker.

== Instalacja Docker ==
Jeśli Docker jeszcze nie jest zainstalowany, należy postępować zgodnie z instrukcją na oficjalnej stronie Docker - [https://docs.docker.com/get-started/get-docker/ Get Docker (en)]

===Compose===
Aby zainstalować program, należy pobrać [https://github.com/Slasherss1/ipwa-selfhosted/releases/latest kod źródłowy do samodzielnego hostingu]. Repozytorium zawiera plik <code>.env.template</code>. Na podstawie pliku należy utworzyć plik <code>.env</code> i zmienić wartości zmiennych:
*<code>DOMAIN=</code> Nazwa domeny na której będzie aplikacja (np. ''ipwa.foliand.men''). Docelowo aplikacja jest na ścieżce <code>/ipwa</code> oraz szuka serwera na ścieżce <code>/api</code>.
*<code>EMAIL=</code> Email administratora. Jest on konieczny do uzyskania certyfikatu ssl. ''(Planowane jest usunięcie tej funkcji, aby uzyskać certyfikat będzie należało użyć innej aplikacji)''
*<code>SECRET=</code> Należy wprowadzić dowolny ciąg znaków. Ważne, aby nikt nie uzyskał do niego dostępu.
Gdy wszystkie zmienne zostały już ustawione system jest gotowy do rozruchu.

Aby uruchomić system, należy wpisać polecenie <code>docker compose up -d</code>.

===Pierwsze kroki===
Najlepiej zacząć od [[IPWA:Tworzenie konta administratora|utworzenia konta administratora]].

IPWA:Start

2026-04-17T12:26:09Z

Slasherss: Dodano notatkę o przeniesieniu kodu

'''IPWA''' (Internat [https://pl.wikipedia.org/wiki/Progressive_web_app Progressive web application]) to projekt zapoczątkowany 16 Maja 2023 w [https://internat.zsgh.torun.pl/ Internacie ZSGH w Toruniu]. Jego głownym celem jest cyfryzacja procesów zachodzących w internatach. Projekt stawia na wygodę i prostotę obsługi, aby ułatwić codzienne funkcjonowanie.

==Dokumentacja==

===Instalacja===
Instrukcja instalacji dla administratorów:
*[[IPWA:Instalacja/Docker|Docker]]

===Wprowadzenie===
*[[IPWA:Tworzenie konta administratora|Tworzenie konta administratora]]
*[[IPWA:Konfiguracja|Konfiguracja]]
*[[IPWA:Zarządzanie użytkownikami|Zarządzanie użytkownikami]]
* [[IPWA:Wskazówki dot. treści|Wskazówki dot. treści]]

===Moduły===
*[[IPWA:Wiadomości|Wiadomości]]
*[[IPWA:Jadłospis|Jadłospis]]
*[[IPWA:Powiadomienia|Powiadomienia]]
*[[IPWA:Grupy|Grupy]]
*[[IPWA:Czystość|Czystość]]
*[[IPWA:Klucze|Klucze]]

===Źródło===
Kod źródłowy aplikacji jest podzielony na dwie części i jest dostępny w serwisie Github:
*[https://github.com/Slasherss1/ipwa Frontend] - Odpowiada za warstwę widoczną dla użytkownika.
*[https://github.com/Slasherss1/ipwa-backend Backend] - Odpowiada za logikę i dane aplikacji.
''Planowane jest połączenie kodu w jedną cześć. Kod w serwisie Github zostanie zarchiwizowany i przeniesiony do serwisu [https://git.foliand.men git.foliand.men].''

===Licencja===

Program dozwolony do użytku na warunkach licencji [https://www.gnu.org/licenses/gpl-3.0-standalone.html GPL-3.0].

__BEZSPISU__
__BEZEDYCJISEKCJI__

IPWA:Grupy

2026-04-17T12:16:13Z

Slasherss: Dodano stronę

IPWA:Jadłospis

2026-04-17T12:07:21Z

Slasherss: Dodano breadcrumb.

IPWA:Jadłospis

2026-04-17T11:57:15Z

Slasherss: Dodano stronę. [WIP]

Moduł ten pozwala na sprawne zarządzanie menu oraz jego atrakcyjną prezentację. Składa się z zaawansowanego edytora, przejrzystego widoku dla odbiorców oraz systemu oceniania poszczególnych dań.

== Układanie jadłospisu ==
{{STUB}}

=== Wybór tygodnia ===

=== Dodanie wpisów dnia ===

=== Wpisywanie pozycji ===

=== Wydruk ===

== Zbieranie opinii ==
{{STUB}}

IPWA:Wiadomości

2026-04-17T10:56:27Z

Slasherss: Dodano przykłady formatowania

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>Moduł wiadomości to cyfrowa tablica ogłoszeń, która ułatwia przepływ bieżących informacji. Dzięki niemu najważniejsze komunikaty są zawsze widoczne i łatwo dostępne dla wszystkich użytkowników.

== Redagowanie treści ==
Aby zarządzać wiadomościami, należy przejść do sekcji '''Wiadomości''' w panelu administracyjnym.

=== Tworzenie nowej wiadomości ===
Aby utworzyć nowy wpis, należy kliknąć przycisk '''"Nowy post"''' znajdujący się na górze strony. Nowe posty są domyślnie ukryte; aby były widoczne, należy przełączyć ich widoczność za pomocą ikony oka pod postem.

=== Dostępne opcje ===
Przy każdym poście są dostępne cztery opcje:

* ✏️ (Ołówek) '''Edytuj''': Edytowanie już istniejącego posta.
* 📌 (Pinezka) '''Przypnij''': Przypięcie wpisu do góry. Posty domyślnie są posortowane według daty utworzenia. Można wymusić aby post wyświetlał się jako pierwszy poprzez przypięcie go. W przypadku kilku przypiętych wpisów, te również zostaną posortowane według daty względem siebie. Status przypięcia jest sygnalizowany przez ikonę pinezki obok tytułu posta.
* 👁️ (Oko) '''Widoczność''': Ikona symbolizuje widoczność posta (Przekreślona ikona oznacza, że post jest niewidoczny). Kliknięcie ikony przełącza widoczność.
* 🗑️ (Kosz) '''Usuń''': Trwałe usunięcie wpisu. System poprosi o potwierdzenie tej akcji. <u>Usunięcie jest nieodwracalne.</u> Jeśli chcemy czasowo wycofać post, należy użyć funkcji ukrywania.

== Formatowanie ==
Moduł wiadomości wspiera formatowanie Markdown (przy pomocy biblioteki [https://marked.js.org/ marked]). Wspierany jest szereg różnych formatów[https://www.markdownguide.org/cheat-sheet/], tutaj zostały podane te najważniejsze:

=== Nagłówki ===
<syntaxhighlight lang="md">
# Nagłówek 1 stopnia
## Nagłówek 2 st.
### Nagłówek 3 st.
</syntaxhighlight>
=== Pogrubienie ===
<syntaxhighlight lang="md">
**Pogrubiony tekst**
</syntaxhighlight>
=== Pochylenie ===
<syntaxhighlight lang="md">
*Pochylony tekst*
</syntaxhighlight>
=== Cytat ===
<syntaxhighlight lang="md">
> Cytat
</syntaxhighlight>
=== Lista numerowana ===
<syntaxhighlight lang="md">
1. Pierwszy element
2. Drugi element
3. Trzeci element
</syntaxhighlight>
=== Lista nieuszeregowana ===
<syntaxhighlight lang="md">
- Pierwszy element
- Drugi element
- Trzeci element
</syntaxhighlight>
=== Linia pozioma ===
<syntaxhighlight lang="md">
---
</syntaxhighlight>
=== Link ===
<syntaxhighlight lang="md">
[Tekst linku](https://example.com)
</syntaxhighlight>
== Zobacz też ==

* [[IPWA:Wskazówki dot. treści]]

IPWA:Wiadomości

2026-04-17T10:29:45Z

Slasherss: Rozbudowano sekcję "Redagowanie treści"

Szablon:STUB

2026-04-17T09:52:21Z

Slasherss: Dodano link do strony edycji.

<div style="font-style: italic;">Ta sekcja wymaga rozbudowania. Możesz pomóc ją <span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit}} rozbudować]</span>.</div>
<noinclude>
Ten szablon powinien być wstawiony zaraz za nagłowkiem sekcji, w celu zaznaczenia że ta powinna być rozbudowana o dodatkowe treści.
</noinclude>

IPWA:Wskazówki dot. treści

2026-04-16T10:55:41Z

Slasherss: link

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Ludzie czytając tekst "skanują" tekst w poszukiwaniu przydatnych informacji. Żeby dobrze rozumiali to, co piszemy, trzeba pisać treści łatwe do przyswojenia. Poniżej znajdziesz wskazówki, które pomogą ci tworzyć treści, które są łatwe do zrozumienia i mówią coś ważnego.

=====Wiadomości=====
*'''Usuń stare wiadomości''': Jeśli jakaś wiadomość nie jest już ważna, to ją schowaj lub usuń. Za dużo starych wiadomości powoduje, że ludzie '''przestają zwracać uwagę''' nawet na ważne ostrzeżenia.
*'''Nie powtarzaj''': Nie pisz tego samego dwa razy. Jeśli coś się zmieniło, to '''popraw starą wiadomość''' zamiast pisać nową.
*'''Używaj pogrubień i list''': Ludzkie oko lubi treści wizualne. Łatwiejsze jest przeczytanie informacji w punktach niż podanych w formie ściany tekstu.

Szczegółowe instrukcje jak dodać formatowanie do tekstu są na stronie [[IPWA:Wiadomości#Formatowanie]].

=====Jadłospis=====
*'''Dziel dane na kategorie''': Przypisuj dania do odpowiednich sekcji. To pomaga systemowi podpowiadać odpowiednie sugestie, co zaoszczędza czas przy planowaniu posiłków.
*'''Dodaj tagi''': Dla powtarzających się opinii, dodaj tagi umożliwiające użytkownikowi '''szybkie oddanie głosu'''. Użytkownikowi często łatwiej jest kliknąć przycisk z gotową opinią, niż samemu ją napisać.

=====Powiadomienia=====
*'''Używaj powiadomień tylko w ważnych sprawach''': Wysyłaj powiadomienia tylko wtedy, kiedy jest to '''naprawdę ważne'''. Za dużo powiadomień powoduje, że ludzie je '''ignorują'''.
*'''Uwzględnienie opóźnień''': Pisz tak, aby Twoje słowa były zrozumiałe nawet wtedy, kiedy ktoś przeczyta je później, ponieważ powiadomienia mogą nie docierać do użytkownika natychmiast.

=====Czystość=====
*'''Nie powtarzaj kategorii''': Nie twórz tych samych kategorii kilka razy. Jeśli musisz coś uszczegółowić, użyj funkcji notatek.

IPWA:Wskazówki dot. treści

2026-04-16T10:54:58Z

Slasherss: link

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Ludzie czytając tekst "skanują" tekst w poszukiwaniu przydatnych informacji. Żeby dobrze rozumiali to, co piszemy, trzeba pisać treści łatwe do przyswojenia. Poniżej znajdziesz wskazówki, które pomogą ci tworzyć treści, które są łatwe do zrozumienia i mówią coś ważnego.

=====Wiadomości=====
*'''Usuń stare wiadomości''': Jeśli jakaś wiadomość nie jest już ważna, to ją schowaj lub usuń. Za dużo starych wiadomości powoduje, że ludzie '''przestają zwracać uwagę''' nawet na ważne ostrzeżenia.
*'''Nie powtarzaj''': Nie pisz tego samego dwa razy. Jeśli coś się zmieniło, to '''popraw starą wiadomość''' zamiast pisać nową.
*'''Używaj pogrubień i list''': Ludzkie oko lubi treści wizualne. Łatwiejsze jest przeczytanie informacji w punktach niż podanych w formie ściany tekstu.

Szczegółowe instrukcje jak dodać formatowanie do tekstu są na stronie [[IPWA:Wiadomości|Wiadomości]].

=====Jadłospis=====
*'''Dziel dane na kategorie''': Przypisuj dania do odpowiednich sekcji. To pomaga systemowi podpowiadać odpowiednie sugestie, co zaoszczędza czas przy planowaniu posiłków.
*'''Dodaj tagi''': Dla powtarzających się opinii, dodaj tagi umożliwiające użytkownikowi '''szybkie oddanie głosu'''. Użytkownikowi często łatwiej jest kliknąć przycisk z gotową opinią, niż samemu ją napisać.

=====Powiadomienia=====
*'''Używaj powiadomień tylko w ważnych sprawach''': Wysyłaj powiadomienia tylko wtedy, kiedy jest to '''naprawdę ważne'''. Za dużo powiadomień powoduje, że ludzie je '''ignorują'''.
*'''Uwzględnienie opóźnień''': Pisz tak, aby Twoje słowa były zrozumiałe nawet wtedy, kiedy ktoś przeczyta je później, ponieważ powiadomienia mogą nie docierać do użytkownika natychmiast.

=====Czystość=====
*'''Nie powtarzaj kategorii''': Nie twórz tych samych kategorii kilka razy. Jeśli musisz coś uszczegółowić, użyj funkcji notatek.

IPWA:Wiadomości

2026-04-16T09:07:38Z

Slasherss: Dodano breadcrumb

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
== Redagowanie treści ==
{{STUB}}

== Formatowanie ==
{{STUB}}

== Zobacz też ==

* [[IPWA:Wskazówki dot. treści]]

IPWA:Wiadomości

2026-04-16T09:05:44Z

Slasherss: Utworzono stronę.

== Redagowanie treści ==
{{STUB}}

== Formatowanie ==
{{STUB}}

== Zobacz też ==

* [[IPWA:Wskazówki dot. treści]]

Szablon:STUB

2026-04-16T09:02:42Z

Slasherss: Dokumentacja

<div style="font-style: italic;">Ta sekcja wymaga rozbudowania.</div>
<noinclude>
Ten szablon powinien być wstawiony zaraz za nagłowkiem sekcji, w celu zaznaczenia że ta powinna być rozbudowana o dodatkowe treści.
</noinclude>

IPWA:Wskazówki dot. treści

2026-04-16T08:02:50Z

Slasherss: Dodano informację o tagach

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Ludzie czytając tekst "skanują" tekst w poszukiwaniu przydatnych informacji. Żeby dobrze rozumiali to, co piszemy, trzeba pisać treści łatwe do przyswojenia. Poniżej znajdziesz wskazówki, które pomogą ci tworzyć treści, które są łatwe do zrozumienia i mówią coś ważnego.

=====Wiadomości=====
*'''Usuń stare wiadomości''': Jeśli jakaś wiadomość nie jest już ważna, to ją schowaj lub usuń. Za dużo starych wiadomości powoduje, że ludzie '''przestają zwracać uwagę''' nawet na ważne ostrzeżenia.
*'''Nie powtarzaj''': Nie pisz tego samego dwa razy. Jeśli coś się zmieniło, to '''popraw starą wiadomość''' zamiast pisać nową.
*'''Używaj pogrubień i list''': Ludzkie oko lubi treści wizualne. Łatwiejsze jest przeczytanie informacji w punktach niż podanych w formie ściany tekstu.

Szczegółowe instrukcje jak dodać formatowanie do tekstu są na stronie [[IPWA:Wiadomości]].

=====Jadłospis=====
*'''Dziel dane na kategorie''': Przypisuj dania do odpowiednich sekcji. To pomaga systemowi podpowiadać odpowiednie sugestie, co zaoszczędza czas przy planowaniu posiłków.
*'''Dodaj tagi''': Dla powtarzających się opinii, dodaj tagi umożliwiające użytkownikowi '''szybkie oddanie głosu'''. Użytkownikowi często łatwiej jest kliknąć przycisk z gotową opinią, niż samemu ją napisać.

=====Powiadomienia=====
*'''Używaj powiadomień tylko w ważnych sprawach''': Wysyłaj powiadomienia tylko wtedy, kiedy jest to '''naprawdę ważne'''. Za dużo powiadomień powoduje, że ludzie je '''ignorują'''.
*'''Uwzględnienie opóźnień''': Pisz tak, aby Twoje słowa były zrozumiałe nawet wtedy, kiedy ktoś przeczyta je później, ponieważ powiadomienia mogą nie docierać do użytkownika natychmiast.

=====Czystość=====
*'''Nie powtarzaj kategorii''': Nie twórz tych samych kategorii kilka razy. Jeśli musisz coś uszczegółowić, użyj funkcji notatek.

IPWA:Wskazówki dot. treści

2026-04-16T07:58:31Z

Slasherss: Zmieniono tekst na dokładniejszy. Dodano breadcrumb.

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Ludzie czytając tekst "skanują" tekst w poszukiwaniu przydatnych informacji. Żeby dobrze rozumiali to, co piszemy, trzeba pisać treści łatwe do przyswojenia. Poniżej znajdziesz wskazówki, które pomogą ci tworzyć treści, które są łatwe do zrozumienia i mówią coś ważnego.

=====Wiadomości=====
*'''Usuń stare wiadomości''': Jeśli jakaś wiadomość nie jest już ważna, to ją schowaj lub usuń. Za dużo starych wiadomości powoduje, że ludzie '''przestają zwracać uwagę''' nawet na ważne ostrzeżenia.
*'''Nie powtarzaj''': Nie pisz tego samego dwa razy. Jeśli coś się zmieniło, to '''popraw starą wiadomość''' zamiast pisać nową.
*'''Używaj pogrubień i list''': Ludzkie oko lubi treści wizualne. Łatwiejsze jest przeczytanie informacji w punktach niż podanych w formie ściany tekstu.

Szczegółowe instrukcje jak dodać formatowanie do tekstu są na stronie [[IPWA:Wiadomości]].

=====Jadłospis=====
*'''Dziel dane na kategorie''': Przypisuj dania do odpowiednich sekcji. To pomaga systemowi podpowiadać odpowiednie sugestie, co zaoszczędza czas przy planowaniu posiłków.

=====Powiadomienia=====
*'''Używaj powiadomień tylko w ważnych sprawach''': Wysyłaj powiadomienia tylko wtedy, kiedy jest to '''naprawdę ważne'''. Za dużo powiadomień powoduje, że ludzie je '''ignorują'''.
*'''Uwzględnienie opóźnień''': Pisz tak, aby Twoje słowa były zrozumiałe nawet wtedy, kiedy ktoś przeczyta je później, ponieważ powiadomienia mogą nie docierać do użytkownika natychmiast.

=====Czystość=====
*'''Nie powtarzaj kategorii''': Nie twórz tych samych kategorii kilka razy. Jeśli musisz coś uszczegółowić, użyj funkcji notatek.

IPWA:Zarządzanie użytkownikami

2026-04-16T06:36:59Z

Slasherss: Dodano breadcrumb

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
== Dodawanie użytkowników ==
Aby dodać użytkownika przechodzimy w panelu administracyjnym do zakładki zarządzanie użytkownikami.

[[Plik:IPWA Panel zarządzanie użytkownikami.png|bezramki|940x940px]]

Kliknij ikonę + obok paska wyszukiwania

[[Plik:IPWA Zarządzanie plus.png|bezramki|940x940px]]

Wpisz wszystkie dane użytkownika (nazwa użytkownika to pole obowiązkowe) i kliknij zapisz.

Domyślne hasło dla każdego użytkownika Jest podane w konfiguracji w sekcji bezpieczeństwo. Należy zachęcać użytkowników do jego zmiany.

== Karta użytkownika ==
Po kliknięciu ikonki w tabeli z użytkownikami, pokazuje się nam karta użytkownika.

[[Plik:IPWA Karta użytkownika2.png]]

Tutaj możemy zmienić danie użytkownika. Po edycji należy kliknąć zapisz.

Opcje resetu oraz blokady nie wymagają zapisywania i mają natychmiastowy efekt.

Reset hasła zmieni je na to podane w konfiguracji w sekcji bezpieczeństwo.

Istnieją dwie blokady:

* Blokada manualna, do przełączenia przyciskiem "Zablokuj konto",
* Blokada automatyczna, nakładane przez system za przekroczenie prób wpisania dobrego hasła. Szary przycisk zamieni się w czerwony. Kliknięcie go odblokuje konto przed upływem czasu.

Uprawnienia dają dostęp do panelu administracyjnego w przyznanym zakresie. Przez panel nie nałożymy uprawnienia "Superadmin", które daje możliwość zmiany uprawnień innych użytkowników i konfiguracji.

IPWA:Konfiguracja

2026-04-16T06:36:13Z

Slasherss: Dodano breadcrumb

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Wszystkie parametry programu można dostosować z panelu administracyjnego.

== Panel Administracyjny ==
Po zalogowaniu, możemy przejść do panelu administacyjnego.

[[Plik:IPWA Start do Zakładka konto.png|940x940px]]

[[Plik:IPWA Konto do panel.png|bezramki|940x940px]]

[[Plik:IPWA Panel menu.png|bezramki|940x940px]]

[[Plik:IPWA Panel ustawienia.png|bezramki|940x940px]]

Zamknij menu poprzez kliknięcie tła, lub kliknięcie ikonki menu na górnym pasku.

== Ustawienia ==
Każda sekcja ustawień to rozwijany panel. Kliknij na niego aby pokazać ustawienia związane z opisem.

=== Pokoje ===
Konfiguracja pokoi służy do wskazania programowi które pokoje powinny być dostępne do wyboru podczas np. oceny czystości.

Aby wpisać pokój do listy, kliknij na element edytora listy (jest on otoczony szarą ramką).

[[Plik:IPWA Lista pokoi.png|bezramki|940x940px]]

=== Powody nieczystości ===
Powody nieczystości pojawiają się dla wychowawców podczas oceniania czystości pokoi jako klikalne punkty do zaznaczenia.

Podobnie jak wcześniej, kliknij edytor listy.

[[Plik:IPWA Powody nieczystości.png|bezramki|940x940px]]

=== Sale z kluczami ===
Sale z kluczami to sale których klucze mogą być wydawane wychowankom. System pomaga śledzić kto aktualnie posiada klucz, kiedy został pobrany i zwrócony.

Program musi wiedzieć do jakich sal klucze można wydać.

[[Plik:IPWA Sale z kluczami.png|bezramki|940x940px]]

=== Ustawienia jadłospisu ===
Ta sekcja jest podzielona na dwie zakładki: Domyślne wpisy jadłospisu i Tagi

==== Domyślne wpisy jadłospisu ====
Domyślne wpisy jadłospisu to te które się pojawiają każdego dnia. Wpisy można dodać w kategoriach śniadanie i kolacja. Domyślne wpisy nie podlegają ocenianiu w ramach systemu zbierania opinii.

==== Tagi ====
Tagi są wybierane przez wychowanków podczas oceniania posiłków. Są one podzielone na różne kategorie (Śniadanie, Zupa, Danie główne, Dodatki, Napój, Kolacja). Warto dodać kilka tagów do każdej kategorii, ponieważ użytkownikowi łatwiej jest kliknąć przycisk, niż samemu wpisać opinię.

=== Bezpieczeństwo ===
W tej sekcji są podane domyślne hasła oraz można sterować blokadami logowania nakładanymi przez program.

Blokady są sterowane przez trzy ustawienia.

# Dozwolone próby logowania
# Okres liczenia prób
# Czas blokady konta

Ustawienia te można inaczej rozumieć jako (liczby podane w nawiasie to podane powyżej ustawienia):<blockquote>W ciągu (2) minut, użytkownik ma (1) podejść na poprawne zalogowanie, jeśli nie uda mu się zalogować – zablokuj konto na (3) minut.</blockquote>Polecam następujące ustawienia:

# 5
# 30
# 15

Wprowadź ustawienia i kliknij zapisz.

Automatycznie nałożone blokady można zdjąć w [[IPWA:Zarządzanie użytkownikami|panelu użytkownika]].

=== Moduły ===
Tutaj można przełączyć każdą funkcję programu. Zapoznaj się z dostępnymi funkcjami na [[IPWA:Start|stronie głównej]].

=== Sterowanie programem ===
Zachowaj szczególną ostrożność przy tych ustawieniach. Przeładowanie w złym momencie może spowodować zepsucie danych. Mimo że szanse są niskie, dalej zaleca się ostrożność.

IPWA:Instalacja/Docker

2026-04-16T06:34:47Z

Slasherss: Dodano breadcrumb

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Aktualnie wspierana jest instalacja programu jako kontenera docker.

== Instalacja docker ==
Jeśli docker jeszcze nie jest zainstalowany, postępuj zgodnie z instrukcją na oficjalnej stronie docker - [https://docs.docker.com/get-started/get-docker/ Get Docker (en)]

=== Compose ===
Aby zainstalować program, pobierz [https://github.com/Slasherss1/ipwa-selfhosted/releases/latest kod źródłowy do samodzielnego hostingu]. Repozytorium zawiera plik <code>.env.template</code>. Zmień jego nazwę na <code>.env</code> (usuń <code>.template</code>). Następnie w pliku <code>.env</code> zmień zmienne:
*<code>DOMAIN=</code> Wprowadź tutaj domenę na której będzie aplikacja (np. ''ipwa.foliand.men''). Docelowo aplikacja jest na ścieżce <code>/ipwa</code> oraz szuka serwera na ścieżce <code>/api</code>.
*<code>EMAIL=</code> Wprowadź tutaj swój email. Jest on konieczny do uzyskania certyfikatu ssl.
*<code>SECRET=</code> Wprowadź tutaj sekret. Może to być dowolny ciąg znaków, ważnym jest aby nikt nie uzyskał do niego dostępu.
Gdy wszystkie zmienne zostały już ustawione program jest gotowy do rozruchu.

Wpisz polecenie <code>docker compose up -d</code>. Polecenie to uruchamia program.

=== Pierwsze kroki ===
Najlepiej zacząć od [[IPWA:Tworzenie konta administratora|utworzenia konta administratora]].

IPWA:Tworzenie konta administratora

2026-04-16T06:34:04Z

Slasherss: Dodano breadcrumb

<yambe:breadcrumb>IPWA:Start</yambe:breadcrumb>
Aktualnie nie została utworzona procedura tworzenia konta.
Aby utworzyć konto należy bezpośrednio połączyć się do bazy danych.

== Mongosh==
[https://www.mongodb.com/docs/mongodb-shell/ Mongosh] to narzędzie do manipulacji bazą danych bezpośrednio z wiersza poleceń.

Aby utworzyć konto należy uruchomić program terminala i wpisać polecenie <code>mongosh</code>

Następnie wybieramy bazę danych

<source>use ipwa</source>

i tworzymy użytkownika (hasło można wygenerować przy pomocy stron takich jak https://bcrypt.online/)
<source>db.logins.insertOne({
uname: 'NAZWA UŻYTKOWNIKA',
pass: 'SZYFROWANE HASŁO',
admin: 255
})</source>
następnie logujemy się w aplikacji przy pomocy wpisanych wyżej danych. Po zalogowaniu można przejść dalej do [[IPWA:Konfiguracja|Konfiguracji]].

==MongoDB Compass==
{{STUB}}

MediaWiki:Copyright

2026-04-16T06:23:08Z

Slasherss: Usunięto link

Wszelkie prawa zastrzeżone © Jan Szumotalski 2025-{{CURRENTYEAR}}. Użycie dozwolone w zgodzie z prawem cytatu (Dz.U. 1994 nr 24 poz. 83 Art. 29).

IPWA:Zarządzanie użytkownikami

2026-04-13T15:09:07Z

Slasherss:

== Dodawanie użytkowników ==
Aby dodać użytkownika przechodzimy w panelu administracyjnym do zakładki zarządzanie użytkownikami.

[[Plik:IPWA Panel zarządzanie użytkownikami.png|bezramki|940x940px]]

Kliknij ikonę + obok paska wyszukiwania

[[Plik:IPWA Zarządzanie plus.png|bezramki|940x940px]]

Wpisz wszystkie dane użytkownika (nazwa użytkownika to pole obowiązkowe) i kliknij zapisz.

Domyślne hasło dla każdego użytkownika Jest podane w konfiguracji w sekcji bezpieczeństwo. Należy zachęcać użytkowników do jego zmiany.

== Karta użytkownika ==
Po kliknięciu ikonki w tabeli z użytkownikami, pokazuje się nam karta użytkownika.

[[Plik:IPWA Karta użytkownika2.png]]

Tutaj możemy zmienić danie użytkownika. Po edycji należy kliknąć zapisz.

Opcje resetu oraz blokady nie wymagają zapisywania i mają natychmiastowy efekt.

Reset hasła zmieni je na to podane w konfiguracji w sekcji bezpieczeństwo.

Istnieją dwie blokady:

* Blokada manualna, do przełączenia przyciskiem "Zablokuj konto",
* Blokada automatyczna, nakładane przez system za przekroczenie prób wpisania dobrego hasła. Szary przycisk zamieni się w czerwony. Kliknięcie go odblokuje konto przed upływem czasu.

Uprawnienia dają dostęp do panelu administracyjnego w przyznanym zakresie. Przez panel nie nałożymy uprawnienia "Superadmin", które daje możliwość zmiany uprawnień innych użytkowników i konfiguracji.

IPWA:Zarządzanie użytkownikami

2026-04-13T09:07:18Z

Slasherss: Utworzono stronę

== Dodawanie użytkowników ==
Aby dodać użytkownika przechodzimy w panelu administracyjnym do zakładki zarządzanie użytkownikami.

[[Plik:IPWA Panel zarządzanie użytkownikami.png|bezramki|940x940px]]

Kliknij ikonę + obok paska wyszukiwania

[[Plik:IPWA Zarządzanie plus.png|bezramki|940x940px]]

Wpisz wszystkie dane użytkownika (nazwa użytkownika to pole obowiązkowe) i kliknij zapisz.

== Karta użytkownika ==
Po kliknięciu ikonki w tabeli z użytkownikami, pokazuje się nam karta użytkownika.

[[Plik:IPWA Karta użytkownika2.png]]

Tutaj możemy zmienić danie użytkownika. Po edycji należy kliknąć zapisz.

Opcje resetu oraz blokady nie wymagają zapisywania i mają natychmiastowy efekt.

Reset hasła zmieni je na to podane w konfiguracji w sekcji bezpieczeństwo.

Istnieją dwie blokady:

* Blokada manualna, do przełączenia przyciskiem "Zablokuj konto",
* Blokada automatyczna, nakładane przez system za przekroczenie prób wpisania dobrego hasła. Szary przycisk zamieni się w czerwony. Kliknięcie go odblokuje konto przed upływem czasu.

Uprawnienia dają dostęp do panelu administracyjnego w przyznanym zakresie. Przez panel nie nałożymy uprawnienia Superadmin, które daje możliwość zmiany uprawnień innych użytkowników i konfiguracji.

Plik:IPWA Karta użytkownika2.png

2026-04-13T09:00:35Z

Slasherss:

karta

Plik:IPWA Zarządzanie plus.png

2026-04-13T08:53:57Z

Slasherss:

zdj

Plik:IPWA Panel zarządzanie użytkownikami.png

2026-04-13T08:51:50Z

Slasherss:

Zdjęcie

IPWA:Konfiguracja

2026-04-13T08:47:40Z

Slasherss: Dodano wzmiankę o zdejmowaniu blokady

Wszystkie parametry programu można dostosować z panelu administracyjnego.

== Panel Administracyjny ==
.Po zalogowaniu, możemy przejść do panelu administacyjnego.

[[Plik:IPWA Start do Zakładka konto.png|940x940px]]

[[Plik:IPWA Konto do panel.png|bezramki|940x940px]]

[[Plik:IPWA Panel menu.png|bezramki|940x940px]]

[[Plik:IPWA Panel ustawienia.png|bezramki|940x940px]]

Zamknij menu poprzez kliknięcie tła, lub kliknięcie ikonki menu na górnym pasku.

== Ustawienia ==
Każda sekcja ustawień to rozwijany panel. Kliknij na niego aby pokazać ustawienia związane z opisem.

=== Pokoje ===
Konfiguracja pokoi służy do wskazania programowi które pokoje powinny być dostępne do wyboru podczas np. oceny czystości.

Aby wpisać pokój do listy, kliknij na element edytora listy (jest on otoczony szarą ramką).

[[Plik:IPWA Lista pokoi.png|bezramki|940x940px]]

=== Powody nieczystości ===
Powody nieczystości pojawiają się dla wychowawców podczas oceniania czystości pokoi jako klikalne punkty do zaznaczenia.

Podobnie jak wcześniej, kliknij edytor listy.

[[Plik:IPWA Powody nieczystości.png|bezramki|940x940px]]

=== Sale z kluczami ===
Sale z kluczami to sale których klucze mogą być wydawane wychowankom. System pomaga śledzić kto aktualnie posiada klucz, kiedy został pobrany i zwrócony.

Program musi wiedzieć do jakich sal klucze można wydać.

[[Plik:IPWA Sale z kluczami.png|bezramki|940x940px]]

=== Ustawienia jadłospisu ===
Ta sekcja jest podzielona na dwie zakładki: Domyślne wpisy jadłospisu i Tagi

==== Domyślne wpisy jadłospisu ====
Domyślne wpisy jadłospisu to te które się pojawiają każdego dnia. Wpisy można dodać w kategoriach śniadanie i kolacja. Domyślne wpisy nie podlegają ocenianiu w ramach systemu zbierania opinii.

==== Tagi ====
Tagi są wybierane przez wychowanków podczas oceniania posiłków. Są one podzielone na różne kategorie (Śniadanie, Zupa, Danie główne, Dodatki, Napój, Kolacja). Warto dodać kilka tagów do każdej kategorii, ponieważ użytkownikowi łatwiej jest kliknąć przycisk, niż samemu wpisać opinię.

=== Bezpieczeństwo ===
W tej sekcji są podane domyślne hasła oraz można sterować blokadami logowania nakładanymi przez program.

Blokady są sterowane przez trzy ustawienia.

# Dozwolone próby logowania
# Okres liczenia prób
# Czas blokady konta

Ustawienia te można inaczej rozumieć jako (liczby podane w nawiasie to podane powyżej ustawienia):<blockquote>W ciągu (2) minut, użytkownik ma (1) podejść na poprawne zalogowanie, jeśli nie uda mu się zalogować – zablokuj konto na (3) minut.</blockquote>Polecam następujące ustawienia:

# 5
# 30
# 15

Wprowadź ustawienia i kliknij zapisz.

Automatycznie nałożone blokady można zdjąć w [[IPWA:Zarządzanie użytkownikami|panelu użytkownika]].

=== Moduły ===
Tutaj można przełączyć każdą funkcję programu. Zapoznaj się z dostępnymi funkcjami na [[IPWA:Start|stronie głównej]].

=== Sterowanie programem ===
Zachowaj szczególną ostrożność przy tych ustawieniach. Przeładowanie w złym momencie może spowodować zepsucie danych. Mimo że szanse są niskie, dalej zaleca się ostrożność.

IPWA:Start

2026-04-13T08:47:00Z

Slasherss: zmieniono nazwę strony zarządzanie użytkownikami

'''IPWA''' (Internat [https://pl.wikipedia.org/wiki/Progressive_web_app Progressive web application]) to projekt zapoczątkowany 16 Maja 2023 w [https://internat.zsgh.torun.pl/ Internacie ZSGH w Toruniu]. Jego głownym celem jest cyfryzacja procesów zachodzących w internatach. Projekt stawia na wygodę i prostotę obsługi, aby ułatwić codzienne funkcjonowanie.

==Dokumentacja==

===Instalacja===
Instrukcja instalacji dla administratorów:
*[[IPWA:Instalacja/Docker|Docker]]

===Wprowadzenie===
*[[IPWA:Tworzenie konta administratora|Tworzenie konta administratora]]
*[[IPWA:Konfiguracja|Konfiguracja]]
*[[IPWA:Zarządzanie użytkownikami|Zarządzanie użytkownikami]]
* [[IPWA:Wskazówki dot. treści|Wskazówki dot. treści]]

===Moduły===
*[[IPWA:Wiadomości|Wiadomości]]
*[[IPWA:Jadłospis|Jadłospis]]
*[[IPWA:Powiadomienia|Powiadomienia]]
*[[IPWA:Grupy|Grupy]]
*[[IPWA:Czystość|Czystość]]
*[[IPWA:Klucze|Klucze]]

===Źródło===
Kod źródłowy aplikacji jest podzielony na dwie części i jest dostępny w serwisie Github:
*[https://github.com/Slasherss1/ipwa Frontend] - Odpowiada za warstwę widoczną dla użytkownika.
*[https://github.com/Slasherss1/ipwa-backend Backend] - Odpowiada za logikę i dane aplikacji.

===Licencja===

Program dozwolony do użytku na warunkach licencji [https://www.gnu.org/licenses/gpl-3.0-standalone.html GPL-3.0].

__BEZSPISU__
__BEZEDYCJISEKCJI__

IPWA:Konfiguracja

2026-04-13T08:20:39Z

Slasherss: Utworzono stronę

Wszystkie parametry programu można dostosować z panelu administracyjnego.

== Panel Administracyjny ==
.Po zalogowaniu, możemy przejść do panelu administacyjnego.

[[Plik:IPWA Start do Zakładka konto.png|940x940px]]

[[Plik:IPWA Konto do panel.png|bezramki|940x940px]]

[[Plik:IPWA Panel menu.png|bezramki|940x940px]]

[[Plik:IPWA Panel ustawienia.png|bezramki|940x940px]]

Zamknij menu poprzez kliknięcie tła, lub kliknięcie ikonki menu na górnym pasku.

== Ustawienia ==
Każda sekcja ustawień to rozwijany panel. Kliknij na niego aby pokazać ustawienia związane z opisem.

=== Pokoje ===
Konfiguracja pokoi służy do wskazania programowi które pokoje powinny być dostępne do wyboru podczas np. oceny czystości.

Aby wpisać pokój do listy, kliknij na element edytora listy (jest on otoczony szarą ramką).

[[Plik:IPWA Lista pokoi.png|bezramki|940x940px]]

=== Powody nieczystości ===
Powody nieczystości pojawiają się dla wychowawców podczas oceniania czystości pokoi jako klikalne punkty do zaznaczenia.

Podobnie jak wcześniej, kliknij edytor listy.

[[Plik:IPWA Powody nieczystości.png|bezramki|940x940px]]

=== Sale z kluczami ===
Sale z kluczami to sale których klucze mogą być wydawane wychowankom. System pomaga śledzić kto aktualnie posiada klucz, kiedy został pobrany i zwrócony.

Program musi wiedzieć do jakich sal klucze można wydać.

[[Plik:IPWA Sale z kluczami.png|bezramki|940x940px]]

=== Ustawienia jadłospisu ===
Ta sekcja jest podzielona na dwie zakładki: Domyślne wpisy jadłospisu i Tagi

==== Domyślne wpisy jadłospisu ====
Domyślne wpisy jadłospisu to te które się pojawiają każdego dnia. Wpisy można dodać w kategoriach śniadanie i kolacja. Domyślne wpisy nie podlegają ocenianiu w ramach systemu zbierania opinii.

==== Tagi ====
Tagi są wybierane przez wychowanków podczas oceniania posiłków. Są one podzielone na różne kategorie (Śniadanie, Zupa, Danie główne, Dodatki, Napój, Kolacja). Warto dodać kilka tagów do każdej kategorii, ponieważ użytkownikowi łatwiej jest kliknąć przycisk, niż samemu wpisać opinię.

=== Bezpieczeństwo ===
W tej sekcji są podane domyślne hasła oraz można sterować blokadami logowania nakładanymi przez program.

Blokady są sterowane przez trzy ustawienia.

# Dozwolone próby logowania
# Okres liczenia prób
# Czas blokady konta

Ustawienia te można inaczej rozumieć jako (liczby podane w nawiasie to podane powyżej ustawienia):<blockquote>W ciągu (2) minut, użytkownik ma (1) podejść na poprawne zalogowanie, jeśli nie uda mu się zalogować – zablokuj konto na (3) minut.</blockquote>Polecam następujące ustawienia:

# 5
# 30
# 15

Wprowadź ustawienia i kliknij zapisz.

=== Moduły ===
Tutaj można przełączyć każdą funkcję programu. Zapoznaj się z dostępnymi funkcjami na [[IPWA:Start|stronie głównej]].

=== Sterowanie programem ===
Zachowaj szczególną ostrożność przy tych ustawieniach. Przeładowanie w złym momencie może spowodować zepsucie danych. Mimo że szanse są niskie, dalej zaleca się ostrożność.

IPWA:Start

2026-04-13T08:18:14Z

Slasherss: Usunięto systemd

'''IPWA''' (Internat [https://pl.wikipedia.org/wiki/Progressive_web_app Progressive web application]) to projekt zapoczątkowany 16 Maja 2023 w [https://internat.zsgh.torun.pl/ Internacie ZSGH w Toruniu]. Jego głownym celem jest cyfryzacja procesów zachodzących w internatach. Projekt stawia na wygodę i prostotę obsługi, aby ułatwić codzienne funkcjonowanie.

==Dokumentacja==

===Instalacja===
Instrukcja instalacji dla administratorów:
*[[IPWA:Instalacja/Docker|Docker]]

===Wprowadzenie===
*[[IPWA:Tworzenie konta administratora|Tworzenie konta administratora]]
*[[IPWA:Konfiguracja|Konfiguracja]]
*[[IPWA:Dodawanie innych użytkowników|Dodawanie innych użytkowników]]
* [[IPWA:Wskazówki dot. treści|Wskazówki dot. treści]]

===Moduły===
*[[IPWA:Wiadomości|Wiadomości]]
*[[IPWA:Jadłospis|Jadłospis]]
*[[IPWA:Powiadomienia|Powiadomienia]]
*[[IPWA:Grupy|Grupy]]
*[[IPWA:Czystość|Czystość]]
*[[IPWA:Klucze|Klucze]]

===Źródło===
Kod źródłowy aplikacji jest podzielony na dwie części i jest dostępny w serwisie Github:
*[https://github.com/Slasherss1/ipwa Frontend] - Odpowiada za warstwę widoczną dla użytkownika.
*[https://github.com/Slasherss1/ipwa-backend Backend] - Odpowiada za logikę i dane aplikacji.

===Licencja===

Program dozwolony do użytku na warunkach licencji [https://www.gnu.org/licenses/gpl-3.0-standalone.html GPL-3.0].

__BEZSPISU__
__BEZEDYCJISEKCJI__

Plik:IPWA Sale z kluczami.png

2026-04-13T08:01:48Z

Slasherss:

Obraz pokazuje co trzeba kliknąć aby wprowadzić klucze

Plik:IPWA Powody nieczystości.png

2026-04-13T07:55:20Z

Slasherss:

Obraz pokazuje co trzeba kliknąć aby wprowadzić powody nieczystości

Plik:IPWA Lista pokoi.png

2026-04-13T07:51:44Z

Slasherss:

Lista pokoi

Plik:IPWA Panel ustawienia.png

2026-04-13T07:43:48Z

Slasherss:

Obraz pokazuje co trzeba kliknąć aby przejść do zakładki ustawień

Plik:IPWA Panel menu.png

2026-04-13T07:39:34Z

Slasherss:

Obraz pokazuje co trzeba kliknąć aby otworzyć pasek menu w panelu administracyjnym