UNPKG

4.1 kBMarkdownView Raw
1FEDS
2====
3
4Pomocná knihovna a CLI nástroj (https://github.com/viktorbezdek/feds-boilerplate)[Front-end Dev Stacku], která zajišťuje, nebo zprostředkovává vytváření projektů, generování součástí, instalaci refillů a knihoven.
5
6<!-- MarkdownTOC depth=10 autolink=true autoanchor=true -->
7
8- [Základní předpoklady][základní-předpoklady]
9- [Instalace][instalace]
10- [Použití][použití]
11 - [Vytvoření nového projektu][vytvoření-nového-projektu]
12 - [Instalace dependencí][instalace-dependencí]
13 - [Vývojový build task][vývojový-build-task]
14 - [Produkční build task][produkční-build-task]
15 - [Generování součástí][generování-součástí]
16 - [Instalace refillů][instalace-refillů]
17
18<!-- /MarkdownTOC -->
19
20<a name="základní-předpoklady"></a>
21## Základní předpoklady
22
23- základní zkušenost s command line nástroji
24- NodeJS 0.12+
25- NPM 2.7.0+
26
27<a name="instalace"></a>
28## Instalace
29
30V terminálu nebo command promptu spusťte:
31
32```bash
33
34$ npm install -g feds-cli
35
36```
37
38<a name="použití"></a>
39## Použití
40
41<a name="vytvoření-nového-projektu"></a>
42### Vytvoření nového projektu
43
44V terminálu nebo command promptu spusťte:
45
46```bash
47
48$ feds --create jmeno_projektu cilovy_adresar repozitar_boilerplate
49
50# nebo
51
52$ feds -c jmeno_projektu cilovy_adresar repozitar_boilerplate
53
54```
55
56- **jmeno_projektu** může být jakýkoli řetězec, pokud obsahuje mezery nebo diakritiku, je třeba jej uzavřít do uvozovek (příklad: "Můj nový projekt")
57- **cilovy_adresar** je cesta relativně od místa, kde byl příkaz `feds` spuštěný, a kde má být nový projekt vytvořený. Cílové místo _nesmí existovat_ (nástroj existující projekt nepřemaže)
58- **repozitar_boilerplate** _NEPOVINNÉ_ je GitHub URL, kde je boilerplate projektu kompatibilní s FEDS. Používejte jen když opravdu víte co děláte.
59
60<a name="instalace-dependencí"></a>
61### Instalace dependencí
62
63Pro instalaci/reinstalaci dependencí, které vyžaduje nový projekt v terminálu nebo command promptu spusťte:
64
65```bash
66
67$ feds --install
68
69# nebo
70
71$ feds -i
72
73```
74
75<a name="vývojový-build-task"></a>
76### Vývojový build task
77
78Vývojový task je spuštěný zatím co pracujete, sleduje vaše soubory a po jejich změně je pomocí gulp tasků zpracovává, zajišťuje reload prohlížeče. Spouští se v terminálu nebo command promptu pomocí příkazu:
79
80```bash
81
82$ feds --development
83
84# nebo
85
86$ feds -d
87
88```
89
90<a name="produkční-build-task"></a>
91### Produkční build task
92
93Zpracuje a zoptimalizuje všechny soubory pro běh na produkčním serveru. Spouští se pomocí příkazu:
94
95```bash
96
97$ feds --build
98
99# nebo
100
101$ feds -b
102
103```
104
105<a name="generování-součástí"></a>
106### Generování součástí
107
108Vygeneruje součást (element, widget, dokumentaci, stránku...) ze šablony.
109
110**Součást se ukládá vždy do adresáře `app/views/druh_soucasti/nazev/`.**
111
112Spouští se pomocí příkazu:
113
114```bash
115
116$ feds --generate druh_soucasti nazev
117
118# nebo
119
120$ feds -g druh_soucasti nazev
121
122```
123
124- **druh_soucasti** může být jedna z šablon `element`, `widget` a `page`
125- **nazev** je jméno, jak se bude nová součást jmenovat. Jmén může být i více. Jméno může předcházet i cesta, kam má být součást uložena (relativně od obvyklého umístění). V případě větších aplikací je hlubší struktura doporučena.
126
127<a name="instalace-refillů"></a>
128### Instalace refillů
129
130Nainstaluje FEDS refill (element, widget) z GitHubu do vašeho projektu.
131
132**Součást se ukládá vždy do adresáře `app/views/druh_soucasti/nazev/`.**
133
134Spouští se pomocí příkazu:
135
136```bash
137
138$ feds --refill nazev_refillu nazev
139
140# nebo
141
142$ feds -refill nazev_refillu nazev
143
144```
145
146- **nazev_refillu** je název refillu pro FEDS, který odpovídá názvu repository na GitHubu bez prefixu `feds-refill-`
147- **nazev** je jméno, jak se bude nová součást jmenovat. Jmén může být i více. Jméno může předcházet i cesta, kam má být součást uložena (relativně od obvyklého umístění). V případě větších aplikací je hlubší struktura doporučena.
148