Projektová vize¶

Zadání¶

Czech-American TV je nekomerční americká televizní společnost, která vysílá své pořady na kabelové televizi v USA již 16 let.
Hlavním posláním Czech-American TV je rozšiřovat povědomí o České republice, ukázat a zviditelnit české regiony a destinace, a přiblížit české kulturní dědictví. Toto veřejné vysílání má formu pravidelných vzdělávacích pořadů, vysílaných pouze v anglickém jazyce. Celý program televize přispívá k vnímání České republiky a jejích regionů jako velmi zajímavé a bezpečné turistické destinace.
Genealogy je WordPress plugin (https://www.catvusa.com/genealogy, www.catvusa.com/tutorial), který je nutný doplnit o další rozšíření. Tato nová funkčnost by měla obsahovat historickou mapu, s různými mapovými podklady, mezi kterými lze snadno překlikávat (např. základní, letecká, turistická, ale i z různých časových období – Rakousko-Uhersko, První republika, Protektorát Čechy a Morava, Československo v období totality atp.). Dále je třeba k pluginu přidat prostředí pro administrace, kde bude možné mapové podklady spravovat, a to včetně importu dat v různých formátech.

Cíle projektu¶

Cílem je upravení kódu pro lepší použití dalšími vývojáře. Vytvoření GUI prostředí pro snadné importování dat do databáze. Vytvoření dokumentaci a upravení bugů v pluginu.

Popis stakeholder¶

Zadavatel: John Honner, ředitel a zakladatel Czech-American TV.
Vývojový tým: Bc. Mukanova Zhanel, Bc. Tomáš Květoň, Bc. Jan Pizúr, Bc. Miroslav Krýsl
Mentor týmu a vedoucí předmětu: doc. Ing. Přemysl Brada Msc., Ph.D.

Požadavky na aplikaci¶

Výsledná aplikace musí splňovat:

• Bezproblémová instalace a aktivace pluginu na Wordressu
• Mít přehledné grafické uživatelské rozhraní (GUI) aplikace
• Plugin bez bugů
• Dobře čitelný a zdokumentovaný zdrojový kód

Produkční prostředí¶

• Celý projekt bude implementovaný ve dvou jazycích: JavaScript a PHP. Budou dodržované konvence psaní kódu v těchto jazycích, pro snadné použiti kódu dalšími programátory. Plugin Genealogy bude nasazen na testový webový server Czech-American TV.
• Implementace projektu bude probíhat na lokálním serveru Wamp, kde bude nainstalovány nástroj Wordpress a rozběhnutý plugin Genealogy.
• Projekt bude verzován programem git a uložen na uložišti GitHub na adrese https://github.com/catvusa/genealogy.
• Za vývojové prostředí jsme si zvolili program PhpStorm s využitím nástroje XDebug pro snadné debuggování webové aplikaci.

Funkční požadavky¶

• Upravit chyby s výpisem v celém pluginu
• Vytvořit prostředí pro snadné přidaní dat do databáze
• Upravit mapu „Genealogy map“, aby zobrazovala správná data

Mimofunkční požadavky¶

• Vytvoření developerské dokumentace
• Refaktorizace a dokumentace kódu
• Předání produktu proběhne na schůzi se zadavatelem - tým předá veškeré projektové dokumenty a výsledná aplikace se spustí na testovacím serveru.

Plán projektu¶

Popis a plánování samotných iteraci je rozepsaný na Wiki stránkách projektu: https://students.kiv.zcu.cz:3443/projects/aswi2021ioi/wiki
Hrubý plán projektu je následující:

• [P1] Refaktorizace kódu.
• [P2] Upravit chyby s výpisem v celém pluginu.
• [P3] Vytvořit prostředí pro snadné přidaní dat do databáze.
• [P4] Vytvoření uživatelské a developerské dokumentace.
• [P5] Vytvořit stránku s historickými mapy.

Priority: [P1] - HIGH, [P5] - LOW

Popis rizik¶

Nezkušenost s technologií¶

• Nikdo z našeho tymu dříve nepracoval s nástrojem Wordpress a zkušenosti s jazyky JavaScript a PHP máme na úrovně předmětu KIV/WEB.
  • Návrh odstranění rizika: Každý z nás zkusí samostatně spustit projekt, který jsme získali od zákazníka. Také je nutné, aby každý účastník projektu si prohlédnul kód s využitím nástroje XDebug pro pochopení funkčnosti pluginu. Možné problémy se musí řešit celým týmem.