Základní informace a návod k použití
O aplikaci
Jedná se o cvičnou jednoúčelovou aplikaci, která má sloužit jako demonstrační ukázka současně pro předměty KIV/WEB a KIV/OKS.
Aplikace je napsána tak, aby byla smysluplně použita většina technologií požadovaných v KIV/WEB.
Aplikace je připravena jako testovatelná, což zejména znamená:
- každý pro ovládání významný element má svoje unikátní ID,
- každá akce má svojí ihned viditelnou – a tudíž ověřitelnou – odezvu.
Aplikace používá reálná data z GitLabu.
- pro demonstrační spuštění v lokální instalaci jsou v nich osobní údaje anonymizované,
- v reálné webové instalaci mohou být osobní údaje skutečné.
Je použit velmi jednoduchý – leč postačující – databázový model.
Role a práva uživatelů
Aplikaci mohou využívat tři typy uživatelů.
-
Nepřihlášený uživatel
- může si ihned prohlížet Celkové přehledy
- může se zaregistrovat v roli studenta či učitele
- pokud je už registrován, může se přihlásit
-
Registrovaný a přihlášený student
- může si změnit heslo
- může si prohlížet Celkové přehledy
- může si prohlížet svoje personalizované podrobné přehledy
-
Registrovaný a přihlášený učitel
- může si změnit heslo
- může si prohlížet Celkové přehledy
- může si prohlížet přehledy všech studentů
- může si prohlížet personalizované podrobné přehledy jednotlivých studentů
- může aktualizovat data
- může resetovat heslo libovolnému studentovi
- může resetovat celou databázi
Jak si aplikaci nainstaluji a spustím lokálně
Je to velmi jednoduché, stačí jen několik málo kroků.
Technické podrobnosti
Detaily mohou být zajímavé...
Jak se jako student mohu zaregistrovat
Zvolíte Nepřihlášený / Registrace a dále z výběrového seznamu vyberete svoje osobní číslo. Zadáte nové heslo a potvrdíte jej.
Pokud svoje heslo následně zapomenete, nemůžete dále aplikaci používat v roli studenta. Řešením může být, že požádáte učitele, aby vám heslo vyresetoval.
Postup instalace
- Rozbalte instalační soubor do adresáře, odkud se spouští localhost
- V lokální SŘBD si založte novou databázi, ideálně se jménem oks-web; databáze bude prázdná
- Soubor env.inc.example.php zkopírujte ve stejném adresáři do souboru env.inc.php (ten je třeba vytvořit)
- V souboru env.inc.php zkontrolujte a případně přenastavte hodnoty konstant DB__SERVER, DB__NAME, DB__USER a DB__PASS
- Do adresního řádku webového prohlížeče zadejte http://localhost/cdg/index.php
- Po úplně prvním spuštění se v SŘBD automaticky vytvoří tři tabulky: nastaveni (předvyplněná), studenti (prázdná) a ulohy (prázdná)
- Zvolte submenu Nepřihlášený / Registrace
- Zaregistrujte se v roli Učitel – protože je učitel pouze jeden, stačí jen zadat jakékoliv počáteční heslo
- V menu Nastavení v záložce Počáteční inicializace načtěte soubor studenti-debug.csv
- V menu Nastavení v záložce Aktualizace úloh načtěte soubor commity-debug.csv
- Od této chvíle můžete aplikaci používat
- Pro práci s reálnými (anonymizovanými) daty načtěte výše uvedeným postupem soubory studenti.csv a commity.csv
- PHP = 7.3.5
- MVC postavený na třídách
- standard PSR-4 vendor/autoload.php
- Bootstrap 4
- ChartJs pro vykreslování grafů
- JavaScript pro řazení v tabulce
- nepoužity Twig šablony
- neoptimalizované dotazy do DB