Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scholarx-assesment/notification-service
Notification service to deliver notifications to related parties about the operations in the institute
https://github.com/scholarx-assesment/notification-service
brevo-api docker fastapi github-actions microservice
Last synced: 4 days ago
JSON representation
Notification service to deliver notifications to related parties about the operations in the institute
- Host: GitHub
- URL: https://github.com/scholarx-assesment/notification-service
- Owner: scholarX-Assesment
- Created: 2024-12-13T19:17:19.000Z (21 days ago)
- Default Branch: main
- Last Pushed: 2024-12-18T09:25:11.000Z (16 days ago)
- Last Synced: 2024-12-18T09:42:22.990Z (16 days ago)
- Topics: brevo-api, docker, fastapi, github-actions, microservice
- Language: Python
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Email Notification Service
## Overview
The Email Notification Service is a FastAPI-based service that provides endpoints to send individual and bulk emails. It is designed to be simple and easy to integrate with other services.
## Features
- Send individual emails
- Send bulk emails
- Easy to set up and use
## Requirements
- Python 3.7+
- FastAPI
- SQLAlchemy
- A configured SMTP server for sending emails
## Setup
### 1. Clone the repository
```bash
git clone https://github.com/yourusername/notification-service.git
cd notification-service
```
### 2. Create a virtual environment and activate it
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
### 3. Install the dependencies
```bash
pip install -r requirements.txt
```
### 4. Configure the database
Update the `DATABASE_URL` in the `app/database.py` file to point to your database.
### 5. Configure the SMTP server
Update the SMTP settings in the `app/email.py` file with your SMTP server details.
### 6. Run the application
```bash
uvicorn main:app --reload
```
The service will be available at `http://127.0.0.1:8000`.
API docs http://127.0.0.1:8000/docs in swagger UI
## API Documentation
For detailed API documentation, refer to the [API-docs.md](./API-docs.md) file.