https://github.com/swarajkumarsingh/go-email-consumer-aws-sqs
Production ready dynamic Golang email consumer service with AWS SQS(Simple Queue Service) & AWS SES(Simple Email Service) written in Golang for high availability, scaling & blazing fast performance , Dockerized for easy development & Deployment
https://github.com/swarajkumarsingh/go-email-consumer-aws-sqs
aws-ses aws-sqs consumer docker go
Last synced: about 1 month ago
JSON representation
Production ready dynamic Golang email consumer service with AWS SQS(Simple Queue Service) & AWS SES(Simple Email Service) written in Golang for high availability, scaling & blazing fast performance , Dockerized for easy development & Deployment
- Host: GitHub
- URL: https://github.com/swarajkumarsingh/go-email-consumer-aws-sqs
- Owner: swarajkumarsingh
- License: mit
- Created: 2024-02-10T10:51:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-11T18:12:09.000Z (10 months ago)
- Last Synced: 2025-03-15T21:14:37.466Z (7 months ago)
- Topics: aws-ses, aws-sqs, consumer, docker, go
- Language: Go
- Homepage: https://github.com/swarajkumarsingh/go-email-consumer-aws-sqs
- Size: 15.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#
Go Email Consumer with AWS SQS & AWS SES
___
---
### Overview
This project provides a production-ready Golang email consumer service utilizing AWS SQS (Simple Queue Service) and AWS SES (Simple Email Service). The service is designed for high availability, scalability, and blazing fast performance. It's Dockerized for easy development and deployment.
## Table of Contents
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Environment Variables](#environment-variables)
- [Contributing](#contributing)
- [Contact](#contact)
- [License](#license)
- [Go](https://golang.org/)
- [Docker](https://www.docker.com/)
- [AWS SES](https://aws.amazon.com/)
- [AWS SQS](https://aws.amazon.com/)
## Features
- AWS Integration: Utilizes AWS SQS for message queuing and AWS SES for sending emails.
- High Availability: Designed to maintain service availability even during high loads or failures.
- Scalability: Easily scalable to handle varying loads of email processing.
- Blazing Fast Performance: Optimized for performance to ensure quick processing of email requests.
- Dockerized: Packaged as Docker containers for seamless development and deployment.
### Prerequisites
Before running this service, ensure you have the following prerequisites installed:
- Docker: Install Docker
- AWS Account: Obtain AWS credentials and configure them locally.
## Environment Variables
Table bellow shows the obligatory environment variables for mariadb container. You should set them based on what was also set for backend container.
Environment variable | Default value | Optional
--- | --- | ---
STAGE | dev | `NO`
SQS_URL | | `YES`
AWS_REGION | | `YES`
AWS_ACCESS_KEY | | `YES`
AWS_SECRET_ACCESS_KEY | | `YES`
## Getting started
```
First of all, correctly configure the Golang development environment on your machine, see https://go.dev/doc/install
- Clone this repository:
$ git clone https://github.com/swarajkumarsingh/go-email-consumer-aws-sqs.git
- Enter in directory:
$ cd go-email-consumer-aws-sqs
- For install dependencies(optional):
$ make run SQS_URL= AWS_REGION= AWS_ACCESS_KEY= AWS_SECRET_ACCESS_KEY=
```
---
### Contributing
Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines:
```
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and test thoroughly.
4. Commit your changes with clear commit messages.
5. Create a pull request against the main branch.
```
## Contact
- Swaraj Singh
feel free to contact me!
## License
> You can check out the full license [here](https://github.com/swarajkumarsingh/go-email-consumer-aws-sqs/blob/main/LICENSE)
This project is licensed under the terms of the **MIT** license
### Acknowledgments
Special thanks to AWS for providing powerful cloud services and Golang community for building robust frameworks and libraries.