Pular para o conteúdo principal

Preparando seu ambiente

Pré-requisitos​

Antes de iniciar, é necessário que você possua em sua máquina:

Também é recomendável:

Instalação​

  1. Acesse o repositório do projeto e faça o clone para sua máquina;
  2. Após clonar, rode o comando npm install para instalar as dependências do projeto;
  3. Inicie o desenvolvimento conforme nossos guidelines de código e de testes.

Comandos​

Alguns comandos que podem ser úteis durante o desenvolvimento do projeto:

  • npm run start:docs: roda o projeto de documentação em localhost:3000.
  • npm run dev:web: cria um ambiente de teste para o projeto do SDK em localhost:8080.
  • npm run test:watch: roda os testes unitários relacionados, cada vez que os arquivos são modificados.
  • npm run test:ci: verifica o percentual de cobertura do código.

Testes​

Para garantirmos o correto funcionamento do SDK para nossos clientes, é de extrema importância que toda funcionalidade adicionada seja testada. Caso haja dificuldade ao testar, busque auxílio de alguém do time, mas NUNCA reduza a cobertura de testes.

Lembrando as 3 Leis do TDD do Uncle BOB:

Você não pode escrever nenhum código fonte, antes de escrever uma especificação de teste que falhe.

Você não pode escrever mais do que um teste para falhar (e não compilar é falhar).

Você não pode escrever mais código fonte do que o suficiente para passar no teste que está falhando.