Snoopy Payment Mercadopago

Snoopy Payment Mercadopago é um BFF que será responsável por tratar as requisições em que o mobile necessite intervir em um pagamento com o parceiro Mercadopago.

Pré-requisitos

:warning: Atenção este respositório conta com dependências e pacotes privados! :warning:

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

Como executar o projeto

O Snoopy Payment 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.

Rodando o Snoopy Payment Mercadopago Localmente

# Clone este repositório
$ git clone [email protected]:acelera/snoopy-payment-mercadopago.git

# Acesse a pasta do projeto no terminal/cmd
$ cd snoopy-payment-mercadopago

# Instalando as dependências
$ yarn install

# Iniciando o snoopy-payment-mercadopago localmente
$ yarn start

Como testar

O Snoopy Payment 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

Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• NodeJS
• Typescript
• Serverless Framework
• VSCode
• AWS CLI
• Yarn

Commits

O projeto utiliza o husky para validações globais do projeto.

pre-commit

• Linter
• Test

commit-msg

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