Skip to content

Latest commit

 

History

History
65 lines (49 loc) · 1.97 KB

README.md

File metadata and controls

65 lines (49 loc) · 1.97 KB
Raw

Adidas email server

Ellaboreted by: Gustavo Roversi

Description

This project sends asynchronous emails for customers managing their subscription Basically, it does 2 process:

  • Send an email for subscription creation
  • Send an email for subscription exclusion

Features

  • Swagger: /adidas/api/swagger-ui.html#
  • Actuator: /adidas/api/actuator/health
  • Traceability and Observability
  • Docker compatible
  • Azure compatible

#Endpoints

  • POST: /adidas/email/v1/subscription/create-subscription - Send an email for subscription creation
  • POST: /adidas/email/v1/subscription/cancel-subscription - Send an email for subscription exclusion

PS: All endpoints, needs a JWS to authorize it access. These JWS are generated by the adidas-backend-for-frontend-mcsv service. Please, read the service documentation.

For more details, see the swagger documentation. (On the repo is also included a Postman collection).

#Dependencies This project needs other projects do work properly. Please download and run the other projects:

For more doubts, reade README section of these projects.

How to run

  • To start application locally, set JVM environment variable.
 spring.profiles.active=local
  • As this service is a Cloud Native application, for production environments, just let the application run on default.

Test

  • ArchUnit tests
  • Integration tests
  • Unit tests
mvn test

Deploy

docker-compose up

CI/CD

This project brings compatibility with kubernetes environment through GitHub actions. Take a look at the .git folder and the manifests' folder.

It's necessary to adjust variables to your environment.

Contact