Skip to content

unofficialopensource-knit/MailerService

Repository files navigation

MailerService

Build Push Go Report Card GitHub go.mod Go version codecov

We need to implement a backend server with the following APIs

  • POST /contact-us This API will be responsible for sending out the contact us email
  • POST /welcome This API will be responsible for sending out the welcome email to the registered user

PreRequisite

In order to run the service locally we would be needing a set of environment variables.

  • ENVIRONMENT, possible values {debug,debug-release,test,release}.
  • BIND_ADDR, only to be used when running in a non-lambda based environment.
  • SMTP_IDENTITY, has to be an empty string "" when using smtp.gmail.com for testing.
  • SMTP_USERNAME, username for authenticating against SMTP server.
  • SMTP_PASSWORD, password for authenticating against SMTP server.
  • SMTP_HOST, host for SMTP server.
  • SMTP_PORT, port for SMTP server.
  • CONTACT_US_DEFAULT_RECIPIENT, mail for contact us default recipients.

Development

  • Use following command to install all dependencies
make install
  • Run linting
make format
  • Run tests
make tests
  • Run dev server
make run-dev