ATENÇÃO

Por favor, troque o nome do snoopy para o nome do novo snoopy nas informações abaixo. O template abaixo é um template modelo!! Fique a vontade em adicionar mais informações, se for preciso!!

Snoopy Consumer Account

Snoopy Consumer Account é um modelo da estrutura de um BFF usando lambda. Ele serve como template para quando precisamos criar um novo Snoopy e não queremos começar do zero e sem exemplos.

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 snooopy-consumer-account 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 Consumer Account Localmente

# Clone este repositório
$ git clone [email protected]:acelera/snooopy-consumer-account.git

# Acesse a pasta do projeto no terminal/cmd
$ cd snooopy-consumer-account

# Instalando as dependências
$ yarn install

# Iniciando o snooopy-consumer-account localmente
$ yarn start

Como testar

O Snoopy Consumer Account 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