Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxjdev/microservice-notification-on-registration
Is a project that implements two microservices: one for managing user registration and another for sending email notifications. When a new user registers, a message is sent via RabbitMQ to the email microservice, which automatically sends a welcome message to the user.
https://github.com/maxjdev/microservice-notification-on-registration
cloud-amqp devtools docker-compose lombok maven postgresql rabbitmq spring-amqp spring-boot spring-data-jpa spring-validation spring-web
Last synced: 9 days ago
JSON representation
Is a project that implements two microservices: one for managing user registration and another for sending email notifications. When a new user registers, a message is sent via RabbitMQ to the email microservice, which automatically sends a welcome message to the user.
- Host: GitHub
- URL: https://github.com/maxjdev/microservice-notification-on-registration
- Owner: maxjdev
- Created: 2024-08-15T01:38:18.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-16T23:02:17.000Z (3 months ago)
- Last Synced: 2024-11-09T03:19:10.738Z (9 days ago)
- Topics: cloud-amqp, devtools, docker-compose, lombok, maven, postgresql, rabbitmq, spring-amqp, spring-boot, spring-data-jpa, spring-validation, spring-web
- Language: Java
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Email Notification on Registration Microservice
## Description
The project consists of two main microservices: one for user management (ms-user) and another for sending email notifications (ms-email). The goal is to create a solution that enables the automatic sending of welcome emails whenever a new user registers on the platform.
The user microservice (ms-user) manages the registration of new users and, after saving the information to the database, publishes a message via RabbitMQ to notify the email microservice (ms-email). Upon receiving this notification, the email microservice composes and sends a welcome email using Spring Mail. Additionally, the status of each sent email is recorded in the database, allowing for tracking of any potential failures.
This decoupled and event-driven architecture ensures that the system is scalable and easy to maintain. The separation of responsibilities between the microservices enhances modularity and facilitates the addition of new features in the future.
## Technologies and Project Dependencies
- **RabbitMQ:** Message broker for asynchronous communication.
- **Spring AMQP:** Integration of Spring with RabbitMQ for sending and receiving messages.
- **Spring Mail:** Integration with email servers for sending messages.
- **Spring Boot:** Framework for building microservices.
- **Spring Web:** For creating RESTful APIs.
- **Spring Devtools:** Additional tools for development, like automatic reload.
- **Spring Data JPA:** Abstraction for data access and JPA entity manipulation.
- **Spring Validation:** For input data validation.
- **Lombok:** Reduces boilerplate code like getters, setters, and constructors.
- **PostgreSQL:** Relational (SQL) database for data persistence.
- **Docker Compose:**
## Testing the Project
- With Docker and Docker Compose installed, navigate to the project directory, open your terminal, and run the following command:
```bash
docker-compose up -d
```
- Add your username and password to the Spring-Mail configurations in the email microservice.
- Add your address to the RabbitMQ configurations in both microservices.
- Start each project using the following command:
```bash
mvn spring-boot:run
```
## Endpoint for testing
| route | description |
|----------------------------------------|---------------------------------------------------------------------------|
| POST /users/post/save | Save a new user |
#### JSON
User:
```json
{
"name": "Jhon",
"email": "[email protected]"
}
```
## Contribution
- Fork this repository and submit your changes via pull requests.
- To report bugs or suggest improvements, open an issue on the project page.