licitacao v1.1.2

Licitação

Comandos

npm install

npm run serve  # Hot-reloads for development

npm run build  # Minifica para produção

npm run lint

npm run test:unit

Guidelines :green_book:

Organização dos pacotes

Este projeto foi organizado seguindo a estrutura de pacotes abaixo:

• public
• src
  • assets
  • commons
  • plugins
  • views

public

Contém os arquivos estáticos que não são diretamente referenciados pelos componentes da pasta src. O webpack simplesmente copia estes arquivos para a pasta raíz de distribuição (dist), por exemplo.

/public
    favicon.ico
    index.html

src/assets

Contém os arquivos estáticos do sistema referenciados dentro dos componentes. É processado pelo webpack sendo renomeado/reorganizado na pasta dist.

/src
    /assets
        logo.png
        stylus.styl

src/commons

Contém componentes .vue e códigos .js utilizadas em várias partes da aplicação.

/src
    /commons
        /components
        /constants
        /filters
        /store
        /utils

Sendo components a pasta que possuem componentes .vue.

/src
    /commons
        /components
            FormatadorMoeda.vue
            ComboOrgao.vue

Sendo constants a pasta que possuem as constantes utilizadas.

/src
    /commons
        /constants
            exceptions.js
            index.js

Sendo filters a pasta que possuem os filtros utilizados.

/src
    /commons
        /filters
            filtro-data.js
            filtro-status-licitacao.js

Sendo store a pasta que possuem dados do vuex.

/src
    /commons
        /store
            actions.js
            getters.js
            index.js
            mutations.js
            state.js

Sendo utils a pasta que possuem códigos utilitários da aplicação.

/src
    /commons
        /utils
            SearchUrlBulder.js
            FileManagerUtils.js

src/plugins

Contém import e configuração de plugins terceiros utilizados na aplicação.

/src
    /plugins
        vuetify.js
        loki.js

src/views

Contém pastas que são telas do sistema, dentro da telas do sistema encontram-se os componentes referentes a mesma.

/src
    /views
        /licitacao
            /edicao
            /pesquisa

Os componentes filhos levam o nome do pai uma vez que os mesmos só existem devido a eles.

<NomeDoComponente>[<NomeDoSubcomponente>][<NomeDoSubSubcomponente>]... até 3 níveis

/src
    /views
        /licitacao
            /edicao
                LicitacaoEdicao.vue
                LicitacaoEdicaoDadosGerais.vue
                LicitacaoEdicaoEdital.vue
            /pesquisa

Organização interna dos componentes

Dentro dos componentes do Vue.js deve-se sempre quando possível manter a seguinte ordem dos elementos:

• name
• props
• components
• data
• computed
• route guards (beforeEnter, beforeUpdate, beforeRouteLeave)
• lifecycle (created, mounted, updated)
• methods (ordem alfabética)

Dentro de cada seção procure:

• Ordenar as propriedades, métodos, computed por ordem alfabética

Nomenclatura dos métodos/funções

Para dar nome aos métodos e funções utilize sempre o padrão:

<verbo><Substantivo>[<complementos>]

• Deve-se utilizar sempre o idioma português dentro do código das aplicações, exceto no código do framework ou bibliotecas opensource.
• Utilize sempre verbos no infinitivo.
• Utilize sempre quando possível o substantivo no singular, exceto situações que são inerentemente no plural.
• Utilize o padrão abaixo de verbos para as ações CRUD:
  • buscar
  • atualizar
  • inserir
  • remover
• Evite palavras com o mesmo significado: carregar, pesquisar, filtrar, retornar, get, find e outros

Nomenclatura das actions/mutations

Para as actions e mutations utilize a mesma nomenclatura de métodos/funções, mas no formato de constantes, ou seja, caixa alta separado por underline, por exemplo: BUSCAR_LICITACAO, BUSCAR_LICITACAO_POR_ID, INSERIR_LICITACAO, ATUALIZAR_LICITACAO e MOSTRAR_MENSAGEM_SUCESSO.