Skip to content

georgepiter/controlz

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

💲 ControlZ - Controle de finanças pessoais 🐷

💻 O projeto foi desenvolvido com:

💻 Pré-requisitos

Antes de começar, verifique se você atendeu aos seguintes requisitos:

  • Você instalou a versão do Java< JDK17 / requeridos>
  • Você instalou a versão< MYSQL 8.0.30 / requeridos>

🚀 Instalando

Após efetuar o clone do Back End adicione o POM do projeto ao Mavem e aguarde o download das dependências.

Em seguida adicione as environments variables com suas configurações:

🔑 URL e credenciais do Banco.

  • DATABASE_URL
  • DATABASE_USERNAME
  • DATABASE_PASSWORD

🔗 Infos de Token.

  • JWT_SECRET - Chave secreta a sua escolha para gerar assinatura do token
  • JWT_EXPIRATION - Tempo de expiração do token em milissegundos

📫 SENDIBLUE - API de envio de e-mail personalizados.

  • SENDINBLUE_API_KEY - Chave gerada para integrar com a API de e-mail´s da sendiBlue.
  • SENDINBLUE_URL - URL de conexão para Integrar com a API do sendiBlue.
  • É necessário cadastro para geração da API key e url, segue o link da documentação https://developers.sendinblue.com/reference/sendtransacemail

DOCKER

Instruções para utilizar o template de e-mails.

O sistema possue dois templates:

Aviso de reset de senha usuário utilizador

Aviso de reset de senha usuário utilizador

Aviso de vencimento de débito

Aviso de vencimento de débito

🗿 O sistema possue 3 jobs:

  • Aviso de vencimento de débitos, que é executado todos os dias e avisa via e-mail os débitos que estão 2 dias antes de vencer.

  • Gera histórico do balanço mensal, todo último dia de cada mês o job cria um balanço de todo o mês.

  • Reenvio de e-mail, todo dia 01:00 é efetuado uma tentativa de reenvio dos e-mails com erro;

  • Existe um webHook que a SENDIBLUE faz um post caso tenha um sucesso ao entregar o e-mail ou falhas.

📫 Contribuindo com o projeto:

Siga estas etapas:

  1. Bifurque este repositório.
  2. Crie um branch: git checkout -b <nome_branch>.
  3. Faça suas alterações e confirme-as: git commit -m '<mensagem_commit>'
  4. Envie para o branch original: git push origin <nome_do_projeto> / <local>
  5. Crie a solicitação de pull.

Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.

😄 Seja um contribuidor

Quer fazer parte desse projeto? Clique AQUI e leia como contribuir.

📝 Licença

Esse projeto está sob licença. Veja o arquivo LICENÇA para mais detalhes.

⬆ Voltar ao topo

About

controlZ project back end

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages