[WIP] Correção da estrutura atual da aplicação

[acidiney]

Motivação

A medida que a aplicação foi crescendo de um simples consultor de nif para um agregador de BI e provincias notei que começou a aparecer tambem as debilidades de não ter uma estrutura definida.

Nessa PR venho com uma proposta de estrutura de forma a melhorar a NON-STRUTURE actual.

O que inclui nessa PR

• Removi finalmente a rota deprecad nif/:nif
• Melhorei a estrutura quebrando em pequenos pedaços os código que outra hora estavam ordenados
• Alterei a rota search/document?type=type&number=number para search/:type/:number [ BREAK CHANGE ]
• Adicionei slug para as provincias de modo permitir a busca por slug e não ID
• Alterei a rota provinces/:id para provinces/:slug
• Adicionei o commit lint e commitzen para padronizar os commits do projecto.
• Fechei as branchs a única forma de fazer os merge é por PR, de modo a que siga o fluxo do Github flow
• Removi o redirect para o Github
• Usar o docs.buscador.ao
• Adicionar testes aos metodos atuais
• Adicionar estrutura de github flow com cobertura de testes
• Adicionar arquivo de contribuidores
• Criar pacote no NPM para facilitar a integração

@JoseCage @FranciiscoCampos170 @overlineink

[overlineink]

Acredito que seria melhor manter o redirect por agora até o site para a documentacão ser lancado.

[JoseCage]

No caso eu recomendo é reencaminhar para docs enquanto não há alguma página web no domínio principal. Landing page etc.

[acidiney]

My bad, eu já tenho o sub-dominio preparado.. mas sim, tem que manter o redirect mesmo por agora, vou corrigir isso

[overlineink]

Já existe alguma preview ou protótipo do site feito?

[acidiney]

Ainda não, mas deve ser algo simples, usarei algum scaffold