1 | [![NPM](https://nodei.co/npm/generator-convenia.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/generator-convenia/)
|
2 |
|
3 | Readme
|
4 | =================
|
5 | Convenia Generator irá gerar e manter seu boilerplate/estrutura de todo front da convenia
|
6 |
|
7 |
|
8 | Instalar
|
9 | ========
|
10 | ```shell
|
11 | npm install -g generator-convenia
|
12 | ```
|
13 |
|
14 | Pré-requisitos
|
15 | =====================================
|
16 | 1. [node](https://nodejs.org/)
|
17 |
|
18 | 2. [yarn](https://yarnpkg.com/)
|
19 |
|
20 | 3. [yeoman](http://yeoman.io/)
|
21 |
|
22 | Comandos
|
23 | ==================
|
24 | 1. Gerar um novo projeto
|
25 |
|
26 | ```shell
|
27 | mkdir meuProjeto
|
28 | cd meuProjeto
|
29 | // o comando a seguir irá fazer o scaffold do projeto e instalar suas dependências com yarn
|
30 | yo convenia
|
31 | ```
|
32 |
|
33 | 2. Gerar uma nova rota [WIP]
|
34 |
|
35 | ```shell
|
36 | //cria "src/app/routename/main.vue" e inclui ele em: "src/app/router/index.js"
|
37 | //cria a pasta "src/app/routename/vuex" e todos seus arquivos (actions, getters, mutations, state e index) e inclui ele como um módulo em "src/vuex/modules.js"
|
38 |
|
39 | yo convenia:route
|
40 | ```
|
41 |
|
42 | 3. Gerar um novo componente [WIP]
|
43 |
|
44 | ```shell
|
45 | //cria "src/components/componentname.vue"
|
46 |
|
47 | yo convenia:comp
|
48 | ```
|
49 |
|
50 | 4. Atualizar o boilerplate/estrutura
|
51 |
|
52 | ```shell
|
53 | // o comando a seguir irá atualizar:
|
54 | //"./build/"
|
55 | //"./config/"
|
56 | //"./static/"
|
57 | //"./src/app/dashboard/"
|
58 | //"./src/app/login/"
|
59 | //"./src/vuex/"
|
60 | //"./src/api.conf.js"
|
61 | //"./src/auth.js"
|
62 | //"./src/utils.js"
|
63 | //"todos os dotfiles"
|
64 |
|
65 | yo convenia:update
|
66 | ```
|
67 | > Aviso: você será perguntado como o overwrite deve proceder: Default, "Y" é overwrite, e "n" é pular.
|
68 |
|
69 |
|
70 | Comandos do projeto
|
71 | =================
|
72 |
|
73 | 1. Iniciar servidor de desenvolvimento local:
|
74 | ```shell
|
75 | yarn dev
|
76 | ```
|
77 |
|
78 | 2. Testes E2E
|
79 | ```shell
|
80 | yarn e2e
|
81 | ```
|
82 |
|
83 | 3. Testes Unitários [WIP]
|
84 | ```shell
|
85 | yarn unit
|
86 | ```
|
87 |
|
88 | 4. Testes [WIP]
|
89 | ```shell
|
90 | yarn test
|
91 | ```
|
92 |
|
93 | 5. Build para produção [WIP]
|
94 | ```shell
|
95 | yarn build
|
96 | ```
|