generator-convenia/README.md

[![NPM](https://nodei.co/npm/generator-convenia.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/generator-convenia/)

Readme
=================
Convenia Generator irá gerar e manter seu boilerplate/estrutura de todo front da convenia


Instalar
========
```shell
npm install -g generator-convenia
```

Pré-requisitos
=====================================
1. [node](https://nodejs.org/)

2. [yarn](https://yarnpkg.com/)

3. [yeoman](http://yeoman.io/)

Comandos
==================
1. Gerar um novo projeto

```shell
mkdir meuProjeto
cd meuProjeto
// o comando a seguir irá fazer o scaffold do projeto e instalar suas dependências com yarn
yo convenia
```

2. Gerar uma nova rota [WIP]

```shell
//cria "src/app/routename/main.vue" e inclui ele em: "src/app/router/index.js"
//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"

yo convenia:route
```

3. Gerar um novo componente [WIP]

```shell
//cria "src/components/componentname.vue"

yo convenia:comp
```

4. Atualizar o boilerplate/estrutura

```shell
// o comando a seguir irá atualizar:
//"./build/"
//"./config/"
//"./static/"
//"./src/app/dashboard/"
//"./src/app/login/"
//"./src/vuex/"
//"./src/api.conf.js"
//"./src/auth.js"
//"./src/utils.js"
//"todos os dotfiles"

yo convenia:update
```
 > Aviso: você será perguntado como o overwrite deve proceder: Default, "Y" é overwrite, e "n" é pular.


Comandos do projeto
=================

1. Iniciar servidor de desenvolvimento local:
```shell
yarn dev
```

2. Testes E2E
```shell
yarn e2e
```

3. Testes Unitários [WIP]
```shell
yarn unit
```

4. Testes [WIP]
```shell
yarn test
```

5. Build para produção [WIP]
```shell
yarn build
```