manual sources

= Používateľská príručka _portálu_ systému Kontr 2

Portál systému Kontr 2 zavádza organizačnú štruktúru, potrebnú na korektné spracovanie odovzdaní domácich úloh.

Tento manuál približuje jeho vybrané rozsiahlejšie časti, prináša prehľad rozhraní, ukážky práce s portálom a

návod na jeho nasadenie.

Tento manuál približuje jeho vybrané rozsiahlejšie časti, prináša prehľad rozhrania a

návod na nasadenie portálu.

Odporúčaným začiatočným bodom sú sekcie obsahujúce návody a ukážky - časti Popis nasadenia a Ukážka nastavenia kurzu.

Odporúčaným začiatočným bodom je sekcia _Popis nasadenia_ obsahujúca návod na získanie a spustenie projektu.

Pre bližšie zoznámenie s projektom nahliadnite do častí X,Y, ktoré poskytujú bližśie informácie o š

pecifických častiach projektu. Tieto sekcie sú vo verzii portálu z bakalárskej práce aktuálne, v ďalšom vývoji projektu

Pre bližšie zoznámenie s projektom nahliadnite do častí _Prehľad povolení_, _Prehľad rozhrania backendu_,

_Dostupné CLI príkazy_ a _Práca s notifikáciami_, ktoré poskytujú bližśie informácie o špecifických častiach projektu.

Tieto sekcie sú vo verzii portálu z bakalárskej práce aktuálne, v ďalšom vývoji projektu

sa v nich očakácajú zmeny.

Prípadné otázky, nejasnosti alebo nájdené chyby prosím smerujte na mailovú adresu **445574@mail.muni.cz**.

Prípadné otázky, nejasnosti alebo nájdené chyby prosím smerujte na mailovú adresu **445574@mail.muni.cz** (Barbora Kompišová).

== Zdroje

Verzia portálu odovzdaná s bakalárskou prácou Barbory Kompišovej predstavuje niekoľko zdrojov.

V prvom rade ide o samotné **zdrojové kódy** projektov, ktoré sa nachádzajú v repozitároch na fakultnom GitLabe:

* https://gitlab.fi.muni.cz/grp-kontr2/portal.git[Backend]

* https://gitlab.fi.muni.cz/grp-kontr2/portal-frontend.git[Frontend]

Predpripravené **prostredia** pre rýchle spustenie backendu a frontendu sú dostupné ako _docker image_,

vytvorené Bc. Petrom Stankom:

* https://hub.docker.com/r/kontr2/portal/[Backend]

* https://hub.docker.com/r/kontr2/frontend/[Frontend]

Verzia docker image a repozitárov častí aplikácie zodpovedajúca stavu pri odovzdaní bakalárskej práce

je označená štítkom (_tag_) `portal-thesis-release`.

**Dokumentácie** návrhu a rôznych častí projektu Kontr 2 sú tiež dostupné ako repozitáre na fakultnom GitLabe:

* https://gitlab.fi.muni.cz/grp-kontr2/kontr-design.git[Návrh]

* https://gitlab.fi.muni.cz/grp-kontr2/kontr-documentation[Dokumentácia]

V službe **Stratus.FI** by mala byť dostupná nasadená inštancia produkčných verzii častí portálu. Virtuálny stroj má

vo fakultnej sieti IP adresu `172.26.1.49`. Obsahuje vzorové dáta, dodávané s projektom. Je možné, že stroj bude časom zrušený -

v tomto prípade ma prosím kontaktujte, aby som mohla situáciu napraviť.

== Popis nasadenia projektov

V tejto časti sa nachádzajú návody, ako je možné nasadiť obe časti portálu vo vývojárskom a produkčnom prostredí.

Návody sú smerované primárne na linuxové distribúcie, predovšetkým *Debian 9 (stable)*, na ktorej bol projekt nasadzovaný v testovacej prevádzke.

Vývojárske prostredie je možné nasadiť aj na platforme Windows.

Návody sú smerované primárne na linuxové distribúcie, predovšetkým *Debian 9 (stable)*, na ktorej bol projekt

nasadzovaný v testovacej prevádzke. Vývojárske prostredie je možné nasadiť aj na platforme Windows, je ale pravdepodobné,

že tam kvôli chýbajúcim povoleniam na prácu so súborovým systémom nebude správne fungovať modul _Storage_.

Prvým krokom je získanie zdrojových kódov projektu. Oba projekty sa nachádzajú v archíve bakalárskej práce. Je tiež možné

projekty stiahnuť z verzovacieho systému *git*:

----

git clone https://gitlab.fi.muni.cz/grp-kontr2/portal.git

cd portal

git reset --hard TODO:commit hash # reset na verziu odovzdanú s bakalárskou prácou, vynechať pre použitie najnovšej verzie

git reset --hard portal-thesis-release # reset na verziu odovzdanú s bakalárskou prácou, vynechať pre použitie najnovšej verzie

cd ..

git clone https://gitlab.fi.muni.cz/grp-kontr2/portal-frontend.git

cd portal-frontend

git reset --hard TODO:commit hash # reset na verziu odovzdanú s bakalárskou prácou, vynechať pre použitie najnovšej verzie

git reset --hard portal-thesis-release # reset na verziu odovzdanú s bakalárskou prácou, vynechať pre použitie najnovšej verzie

----

Ďalšie návody predpokladajú, že používateľ je v priečinku `portal` pre prácu s backendom

flask courses create <course_codename> # voliteľné: vytvorí vzorový kurz s daným kódom

----

**Vzorové dáta** pre **vývojárske prostredie** obsahujú:

* kurz `TestCourse1`

* kurz `TestCourse2`

* používateľa `student1` (heslo 123456)

** študent kurzu TestCourse1

* používateľa `student2` (heslo 123456)

** študent oboch kurzov

* používateľa `teacher1` (heslo 123123)

** vyučujúci kurzu TestCourse1

** študent kurzu TestCourse2

* používateľa `teacher2` (heslo 123123)

** vyučujúci oboch kurzov

* používateľa `lecturer1` (heslo 654321)

** vlastník oboch kurzov

Vzorové kurzy obsahujú niekoľko skupín, rolí a projektov. Definícia

vzorových dát sa nachádza v súbore `data_dev.py` v priečinku `management/data` projektu.

Samotnú aplikáciu je možné spustiť

* príkazom `flask run -port <PORT_NUM>` pre vývojárske prostredie

** používateľ smie znovu odovzdať existujúce odovzdanie pod identitou pôvodného vlastníka

** neobmedzené časovými obmedzeniami projektu (submissions allowed from-to)

** typické povolenie vlastníka kurzu

** TODO: nevyužité?

* update_course:

** umožňuje zmenu informácii kurzu (meno, kód)