Skip to content

Uživatelská příručka

stepanekp edited this page May 22, 2023 · 8 revisions

Aktuální k 22.5.2023

  • Po spuštění aplikace se otevře domovská stránka obsahující základní informace o projektu Software Process Anti-pattern Detector (SPADe).
  • V horní části se pak nachází navigační lišta.
    • V levé části se nachází prokliky na ostatní části aplikace
    • v pravé části se pak nachází tlačítko pro přihlášení

home

  • Ostatní části aplikace jsou v tuto chvíli zpřístupněny pouze přihlášeným uživatelům (viz Přihlášení)

Přihlášení

  • Pro přihlášení je nutné kliknout na tlačítko Sign In v pravé části navigační lišty
  • Poté dojde k přesměrování na přihlašovací formulář vyžadující přihlašovací jméno a heslo
  • V případě, že uživatel nemá vytvořený uživatelský účet, je nutné ho založit kliknutím na Sign up pod formulářem (viz Registrace)

signin

  • Pokud se přihlášení nepovedlo, například z důvodu neplatného uživatelského jména a hesla, je uživatel upozorněn a může přihlášení provést znovu

signin-failed

  • V případě úspěšného přihlášení je uživatel přesměrován na stránku potvrzující tuto skutečnost (bude v budoucnu odstraněna)
  • V tuto chvíli jsou uživateli zpřístupněny ostatní části aplikace
  • Zároveň došlo ke změně pravé části navigační lišty, která nyní obsahuje tlačítko pro odhlášení, jméno přihlášeného uživatele a rozevírací seznam dostupných konfigurací (viz Konfigurace)

logged-in

Registrace

  • Pro registraci je nutné vyplnit standardní formulář vyžadující uživatelské jméno, email, heslo a znovu heslo pro potvrzení.

signup

Detekce

  • Na stánku pro spuštění detekce je možné se dostat stiskem "Detect" v navigační liště.
  • Po výběru konfigurace, projektů a anti-vzorů je možné detekci zahájit stisknutím tlačítka "Detect" v dolní části
  • Následně dojde k přesměrování na stránku s výsledky detekce (viz Zobrazení výsledků detekce)

detect-button-detail

Výběr konfigurace

  • Každá detekce je spuštěná s aktuálně vybranou konfigurací v pravé části navigační lišty. Tuto konfiguraci je možné měnit jednoduchým rozkliknutím seznamu a vybráním požadované konfigurace
  • Je také možné vytvářet či upravovat dostupné konfigurace (viz Konfigurace)

nav-right-detail

Výběr projektů a anti-vzorů

  • Na stránce se nachází dva seznamy, jeden s dostupnými projekty a druhý s dostupnými anti-vzory
  • Na této stránce je možné vybrat množinu projektů a anti-vzorů, které se budou detekce účastnit
    • K tomu je možné využít zaklikávacích polí u jednotlivých projektů a anti-vzorů
    • Další možností je využití pole "Quick Select" umožňující rychlý výběr všech dostupných položek

detect

Zobrazení výsledků detekce

  • Výsledky detekce jsou zobrazené v tabulce
  • Pokud byl daný anti-vzor v daném projektu detekován, je na příslušném místě v tabulce zobrazeno červené kolečko s fajfkou
  • V opačném případě je na příslušném místě v tabulce zobrazeno zelené kolečko s křížkem

tesults

Konfigurace

  • Na stánku nastavení a vytváření konfigurací je možné se dostat stiskem "Configuration" v navigační liště.

V současné verzi aplikace není stránka pro nastavení a vytváření konfigurací dostupná

About

  • Na stánku nastavení konfigurací je možné se dostat stiskem "About" v navigační liště.
  • Tato stránka obsahuje metadata o aplikace, tedy její jednotlivé verze a autory těchto verzí

about