Mail Service

Mail Service a modular service that sends emails to users.

Table of Contents

• Features
• Prerequisites
• Installation
• Configuration
• Usage
• License

Features

• API Endpoints: Provides endpoints to send emails.
• Database Integration: Connects to a PostgreSQL database to obtain data.
• Docker Support: Can be run in a Docker container.
• Logging: Logs information to the console.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Docker and Docker Compose installed on your machine.
• Java 22 or higher installed on your machine.
• Maven installed on your machine.
• PostgreSQL database.

Installation

Clone the Repository

git clone https://github.com/daily-coding-problem/mail-service.git
cd mail-service

Install Dependencies

mvn -ntp dependency:go-offline

Setup Docker

If you would like to use Docker, ensure Docker and Docker Compose are installed on your machine. If not, follow the installation guides for Docker and Docker Compose.

Build Docker Images

docker compose build mail-service

Create the Network

docker network create dcp

Configuration

Environment Variables

Create a .env file in the project root with the content found in the .env.example file.

Usage

Start the service with Docker:

docker compose up -d mail-service && docker compose logs -f mail-service

Or without Docker:

mvn spring-boot:run

License

This project is licensed under the MIT License - see the LICENSE file for details.