envelope-cliente-js v1.1.0

Cliente-js - Envelope

Clientes Javascript para comunicação com o servidor Envelope.

Este cliente foi desenvolvido utilizando-se dos novos padrões de desenvolvimento de aplicações Javascript.

A versão da linguagem utilizada é a ES6, mas para a retrocompatibilidade e para o gerenciamento de módulos, está sendo utilizada a ferramenta Webpack. Para utilizar esse projeto é necessário compreender a utilização do Webpack.

Este módulo é testado com auxílio da ferramenta Mocha. Sempre execute os testes antes de publicar.

Conceitos importantes:

• Agente: É o cliente que será executado juntamente com as aplicações que irão enviar dados ao Envelope
• Admin: É o cliente que será executado na página de administração. Vide o módulo frontend-admin

Desenvolvimento

O Fluxo de desenvolvimento é o seguinte:

1. Altere o código
2. Faça testes
3. Rode os testes
4. Gere uma versão bundle
5. Teste o bundle no Navegador junto com o serviço do Envelope.

Obs.:

Os testes ficam no diretório test/. Para executar os testes, use o comando yarn test.

Para gerar um bundle use o comando yarn build. O bundle será gerado no diretório dist/.

Para testar no navegador e ver como a aplicação se comporta, abra no browser o arquivo dist/index.html. Faça todos debugs e verificações pelo browser antes de publicar as alterações.

Publicação

Atualmente a publicação é feita manualmente. Basta copiar e colar dos arquivos bundle gerados em dist/ para os projetos destino.