Billet Generator e Email Sender

Descrição

Este projeto é uma aplicação serverless que gera boletos e envia e-mails usando serviços de terceiros. Utiliza a biblioteca Pub/Sub para gerenciar as mensagens e a biblioteca Axios para fazer requisições HTTP.

Funcionalidades

• Geração de boletos: Utiliza o serviço Kobana para gerar boletos bancários.
• Envio de e-mails: Utiliza o serviço Mailgun para enviar e-mails.
• Gerenciamento de mensagens: Utiliza a biblioteca Pub/Sub para gerenciamento de mensagens.

Requisitos

• Node.js: 14 ou superior
• TypeScript: 4 ou superior

Bibliotecas

• Pub/Sub
• Axios
• Kobana
• Mailgun

Instalação

1. Clone o repositório:

   git clone https://github.com/andersonRocha091/bank-billet-generator.git

2. Navegue até o diretório do projeto:

   cd bank-billet-generator

3. Instale as dependências:

   npm install

4. Configure as variáveis de ambiente. Crie um arquivo .env na raiz do projeto e adicione as seguintes variáveis:

   KOBANA_CLIENT_ID=seu-client-id
   KOBANA_CLIENT_SECRET=seu-client-secret
   KOBANA_API_URL=https://api.kobana.com.br
   KOBANA_AUTH_URL=https://auth.kobana.com.br
   MAILGUN_API_KEY=seu-mailgun-api-key
   MAILGUN_DOMAIN=seu-mailgun-domain

Uso

1. Faça deploy de sua aplicacao em sua conta do Google Cloud Platform:

   npm deploy

2. A aplicação irá gerar boletos e enviar e-mails automaticamente conforme a configuração.

Arquivos e Pastas

• src/: Pasta contendo o código fonte da aplicação.
  • src/handler.ts: Arquivo com os entrypoints para execucao da aplicacao
  • src/client: Clientes para conexao externa à aplicacao
  • src/utils/: Pasta contendo funções auxiliares.
  • src/interfaces/: Pasta contendo interfaces e tipos.
  • src/services/: Pasta os serviços que implementam a logica de negocios da aplicacao
  • src/validation/: Pasta com classes tipadas para validacao de dados
  • src/factory: Pasta contendo classes de fábrica para criar instâncias de serviços e clientes.
• package.json: Arquivo contendo as dependências e scripts do projeto.

Contribuição

Contribuições são bem-vindas! Se você encontrar um bug ou tiver uma sugestão, por favor, abra uma issue ou envie um pull request.

Licença

Este projeto é licenciado sob a licença MIT. Veja o arquivo LICENSE para mais informações.