Yara - Message in a Bottle
-
Yara é uma aplicação que permite o envio de e-mails automatizados com mensagens pré-formatadas (ou não) a usuários cadastrados em um banco de dados;
-
Com o programa é possível criar, buscar, deletar e fazer update do cadastro de usuários, associando-os a endereços eletrônicos e um id;
-
Há também um repositório de mensagens que recebe temas e textos pré-definidos, onde também é possível gerenciar de forma constante, fazendo busca por assuntos e registro;
-
Utilizando uma ferramenta auxiliar (Postman), é possível confirmar o envio, retornando data e horário. O aplicativo roda em nuvem graças ao Heroku, plataforma de Deploy. Desta forma, é possível acessar as funções em qualquer máquina.
Criado por
- Anuar Samir Mamede
- Allan Arruda
- Fábio Clericuzi
- Túlio Albuquerque
Mentoria:
- Rui Arthur Nunes
- Samuel França
Trabalho de conclusão do curso NExT - Nova Experiência de Trabalho; Sem fins comerciais;
O que você vai precisar para rodar locamente a aplicação
- OpenJDK 17.0.2+;
- Maven 4.0+;
- Você pode copiar o código direto para sua IDE. Nós usamos o VS Code;
- Uma ferramenta para fazer REST requests. Recomendamos o Postman;
- Spring Boot 2.7.0+;
- JBDC Connector).
No entanto, não é necessário rodar o código na sua máquina. A aplicação funciona em nuvem através do Heroku e você pode acessar as instruções no link https://api-yara-sendingemail.herokuapp.com/;
CRUD de Usuários
Caso que queira rodar a aplicação localmente, primeiro você terá que ir em Aplication Properties e atualizar os dados de username e senha, considerando seu banco de dados local e o endereço que enviará as mensagens pré-formatadas;
Depois de rodar a aplicação e com o banco de dados sincronizado na sua máquina, você precisará de uma ferramenta para fazer REST Requests. Todos os testes de funcionalidade do CRUD e do envio de e-mail deste projeto foram feitos usando o Postman.
O banco de dados recebe informações sobre usuários, com os parâmetros "nameUser" e "emailUser".
Utilize o seguinte formato:
{
"nameUser": "MariaClara",
"emailUser": "[email protected]"
}
http://localhost:8080/users - Para uso local
http://localhost:8080/users/id - Para uso local
exemplos: http://localhost:8080/users/12 - Para uso local
CRUD de Mensagens
Há também uma forma de adicionar mensagens pré-formatadas na tabela, com os parâmetros "messageSubject" e "messageText".
Utilize o seguinte formato:
{
"messageSubject": "Natal",
"messageText": "Feliz Natal !!"
}
http://localhost:8080/message - Para uso local
http://localhost:8080/message/id - Para uso local
Enviando e-mails
Para enviar e-mails utilizando a tabela de usuários, você deve seguir o seguintes modelos:
http://localhost:8080/sending-email/nameUser - Para uso local
Exemplo: sending-email/AllanArruda
No corpo do email, você deve preencher os campos subject e text;
Utilize o seguinte formato:
{
"subject": "Aniversário",
"text": "Parabéns João !!"
}
Para enviar e-mail usando mensagens pré-cadastradas para usuários cadastrados, utilize a seguinte URL: http://localhost:8080/sending-email/nameUser/messageSubject - Para uso local
No campo "nameUser" será passado o nome conforme foi cadastrado, sem espaço, e no "messageSubject" será passado o assunto da mensagem de e-mail também conforme cadastrado no banco de dados:
exemplo: http://localhost:8080/sending-email/TulioAlbu/Aniversario - Para uso local
118 Dec 13, 2022
15 Dec 27, 2022
2 Sep 10, 2022
16 Jun 3, 2022
3 Oct 12, 2021
27 Nov 13, 2022