Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.39 KB

README.md

File metadata and controls

42 lines (31 loc) · 1.39 KB

A Dockerized Micro-service for sending Email Notifications by Team-Fierce

Description:

This is an Email micro-service that sends emails using Swagger UI template and an API. It was built to avoid development teams having to configure mail over and over on projects involving a micro-services infrastructure.

It was built using Django-Rest Framework and a Docker file was included for easy development. Documentation is managed by Swagger with the drf-yasg module.

Features:

  • Sending Email
  • Sending Email with Template
  • Sending Predefined emails with templates

Requirements:

This Project requires the following Versions:

Python (3.5, 3.6, 3.7, 3.8)

Django (1.11, 2.0, 2.1, 2.2, 3.0)

Installation:

To install all dependencies in this project, open your terminal and run:

pipenv install
pipenv shell
python manage.py runserver

To Contribute:

Please always follow the right format in making pull request

  • Fork this repository into your remote repository
  • Clone the code form your remote repository into your local machine
  • Create a branch with the feature name you wish to work on
  • Add any changes
  • Create an upstream on your local amchine to pull the latest code from the develop branch of this repository
  • Push to your remote branch
  • Make a pull request to the develop branch of this repository

Credits:

HNGi7 team-fierce backend