Snoopy Payment Partner Mercadopago é um repositório com estrutura de um BFF usando lambdas. Ainda que seu surgimento siga os moldes de BFF realizará interface com o parceiro de pagamento MercadoPago, seguindo a nova proposta de arquitetura e recebendo requisições exclusivamente vindas do parceiro.
Antes de começar, você vai precisar ter instalado em sua máquina todas as ferramentas descritas na seção TECNOLOGIA deste README.
Antes de executar este projeto, você precisa cumprir os seguintes requisitos
- Criar e configurar as credenciais AWS
O Snoopy Payment Partner Mercadopago conta com o plugin Serverless Framework Offline para execução local, então ao iniciar este projeto localmente você terá todas as lambdas deste microsserviço rodando em sua máquina. Algumas funções sem gatilho HTTP configuradas, terão rotas de testes geradas automaticamentes apenas para testes locais.
# Clone este repositório
$ git clone git@bitbucket.org:acelera/snoopy-payment-partner-mercadopago.git
# Acesse a pasta do projeto no terminal/cmd
$ cd snoopy-payment-partner-mercadopago
# Instalando as dependências
$ yarn install
# Iniciando o snoopy-payment-partner-mercadopago localmente
$ yarn start
O Snoopy Payment Partner Mercadopago utiliza o JEST para realizar seus testes. Após a instalação de todos os pacotes você precisa apenas executar o comando
yarn test
Ou se precisar de um teste coverage, basta executar
yarn test:coverage
As seguintes ferramentas foram usadas na construção do projeto:
O projeto utiliza o husky para validações globais do projeto.
- Linter
- Test
O commit-msg possui o padrão (conventionals commit)[https://www.conventionalcommits.org/en/v1.0.0/]. Esse padrão possui validações no formato da mensagem do commit, como mostra a o exemplo seguir:
type(task): message
type: test | feat | refactor | style | fix | chore | docs | build | perf | ci | revert task: O número da task do jira, como por exemplo TWAUTZ-10 message: Mensagem do commit e esta deve possuir apenas letras minúsculas
feat(TWAUTZ-10): initia config tests, added jest