Projekt

Obecné

Profil

Upravit Historie

SensLog » Dokumentace »

Produktová dokumentace » Historie » Verze 23

Martin Lácha, 2021-05-27 15:08

1 1 Martin Lácha 
h1. Produktová dokumentace
2 





    3
    4
    Martin Lácha
    
h2. Aplikace





    4
    
    
    





    5
    
    
    
* Angular/Angular CLI 11.2.3





    6
    
    
    
* HTML 5.0





    7
    
    
    
* CSS 3.0 (preprocesor SASS/SCSS)





    8
    
    
    
* Bootstrap 4.6.0





    9
    
    
    
* PrimeNG 11.3.1





    10
    
    
    
* Vega 5.20.2





    11
    
    
    





    12
    1
    Martin Lácha
    
h2. Funkční požadavky





    13
    
    
    





    14
    
    
    
* Přihlášení uživatele





    15
    
    
    
* Přidání nového uživatele (pouze admin)





    16
    
    
    
* Přidání nové jednotky





    17
    
    
    
* Vytvoření nového senzoru do jednotky





    18
    
    
    
* Úprava jednotky





    19
    
    
    
* Úprava senzoru





    20
    
    
    
* Odstranění jednotky





    21
    
    
    
* Odstranění senzoru





    22
    
    
    
* Zobrazení grafu pro senzor





    23
    
    
    
* Zobrazení grafu pro jednotku





    24
    3
    Martin Lácha
    





    25
    12
    Martin Lácha
    
h2. Datový model





    26
    
    
    





    27
    
    
    
!senslog_v1-model.png!





    28
    
    
    





    29
    3
    Martin Lácha
    
h2. Konvence pro vývoj





    30
    
    
    





    31
    
    
    
* [[Konvence]]





    32
    5
    Martin Lácha
    





    33
    6
    Martin Lácha
    
h2. Struktura projektu





    34
    8
    Martin Lácha
    





    35
    7
    Martin Lácha
    
<pre><code class="text">





    36
    
    
    
|





    37
    10
    Martin Lácha
    
├── e2e





    38
    
    
    
│   





    39
    1
    Martin Lácha
    
├── _src





    40
    10
    Martin Lácha
    
│   ├── app





    41
    
    
    
│   ├── assets





    42
    
    
    
│   ├── environments





    43
    
    
    
│   ├── vega





    44
    11
    Martin Lácha
    
│   ├── favicon.ico





    45
    
    
    
│   ├── index.html





    46
    
    
    
│   ├── main.ts





    47
    
    
    
│   ├── polyfills.ts





    48
    
    
    
│   └── test.ts





    49
    10
    Martin Lácha
    
├── .browserslistrc





    50
    
    
    
├── .dockerignore





    51
    
    
    
├── .editorconfig





    52
    
    
    
├── Dockerfile





    53
    
    
    
├── README.md





    54
    
    
    
├── angular.json





    55
    
    
    
├── compose.yml





    56
    
    
    
├── karma.conf.js





    57
    
    
    
├── nginx.conf





    58
    
    
    
├── package-lock.json





    59
    
    
    
├── package.json





    60
    
    
    
├── proxy-config.json





    61
    
    
    
├── tsconfig.app.json





    62
    
    
    
├── tsconfig.json





    63
    
    
    
├── tsconfig.spec.json





    64
    
    
    
└── tslint.json





    65
    6
    Martin Lácha
    
</code></pre>





    66
    
    
    





    67
    18
    Lukáš Moučka
    
h2. Komponenty





    68
    5
    Martin Lácha
    





    69
    17
    Martin Lácha
    
Dashboard je tvořený z jednotlivých komponent (přihlášení, dashboard, zobrazení grafů). Některé komponenty mohou dále obsahovat další komponenty (pop-up okna).





    70
    5
    Martin Lácha
    





    71
    
    
    
h3. Vytvoření nové komponenty





    72
    
    
    





    73
    
    
    
Pro vytvoření nové komponenty do dashboardu se použije přikaz:





    74
    
    
    





    75
    
    
    
<pre><code class="text">





    76
    
    
    
ng generate component component-name





    77
    
    
    
</code></pre>





    78
    14
    Martin Lácha
    





    79
    16
    Martin Lácha
    
h3. Struktura komponenty





    80
    
    
    





    81
    
    
    
<name> - název dané komponenty





    82
    
    
    





    83
    
    
    
* <name>.component.html





    84
    
    
    
* <name>.component.scss





    85
    
    
    
* <name>.component.ts





    86
    
    
    
* <name>.module.ts





    87
    
    
    





    88
    14
    Martin Lácha
    
h2. Produkční prostředí





    89
    
    
    





    90
    15
    Martin Lácha
    
Jako produkční server pro nasazení aplikace je použitý virtuální server KIV FAV ZČU. Na tomto serveru bude nasazena poslední verze webové aplikace. Pro konfiguraci a přehled informací o aplikaci (využití CPU, paměti, počet spuštěných nebo nasazených webových aplikací atd.), bude sloužit https://nuada.zcu.cz/.





    91
    19
    Martin Lácha
    





    92
    22
    Martin Lácha
    
h2. Responzivní web





    93
    
    
    





    94
    
    
    
Celá webová aplikace je responsivní pro různé velikosti obrazovek podle následujících breakpointů.





    95
    
    
    





    96
    
    
    
<pre><code class="text">





    97
    
    
    
  xs: 0,





    98
    
    
    
  sm: 576px,





    99
    
    
    
  md: 768px,





    100
    
    
    
  lg: 992px,





    101
    
    
    
  xl: 1348px





    102
    
    
    
</code></pre>





    103
    
    
    





    104
    21
    Martin Lácha
    
h2. Výsledky testování





    105
    1
    Martin Lácha
    





    106
    23
    Martin Lácha
    
Webová aplikace byla testována pomocí automatických testů. Všechny scénáře testů proběhli úspěšně bez nalezení jakéhokoliv problému. Poslední testování bylo provedeno po posledním commitu vývoje dne 23. 5. 2021. Testy probíhali ve webovém prohlížeči verze 90.0.4430.212 a všechny testy byly dokončeny do 1 minuty.





    107
    
    
    





    108
    
    
    
!tests.png!