https://github.com/jorbush/jorbites-notifier
a lightweight notification service for Jorbites platform written in Go
https://github.com/jorbush/jorbites-notifier
email golang microservice notification-service notifier
Last synced: about 1 month ago
JSON representation
a lightweight notification service for Jorbites platform written in Go
- Host: GitHub
- URL: https://github.com/jorbush/jorbites-notifier
- Owner: jorbush
- Created: 2025-02-20T17:26:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-05-11T17:57:54.000Z (3 months ago)
- Last Synced: 2026-05-11T18:16:06.593Z (3 months ago)
- Topics: email, golang, microservice, notification-service, notifier
- Language: Go
- Homepage:
- Size: 2.58 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Security: docs/security.md
Awesome Lists containing this project
README
# Jorbites Notifier
A lightweight notification service for Jorbites platform written in Go.
## Overview
Jorbites Notifier is a microservice designed to handle notifications for the Jorbites platform. It provides a simple FIFO queue for processing notifications and supports email delivery.
## Features
- Simple FIFO notification queue
- Email notifications
- RESTful API for notification management
- Lightweight implementation with minimal dependencies
## API Endpoints
| Endpoint | Method | Description |
|----------|--------|-------------|
| `/health` | GET | Health check endpoint |
| `/notifications` | POST | Add a notification to the queue |
| `/queue` | GET | Get the current queue status |
## Running the service
```bash
go mod tidy # Install dependencies
go run cmd/server/main.go # Run the service
```
Or using the Makefile:
```bash
make run
```
## Running the service in Docker
```bash
make docker
```
## Documentation
For detailed documentation, check the [docs](./docs) directory.