GoFr-SOC: Template Track – Notification Service

[Kake27]

Hello GoFr Team, I will be working on a scalable and modular notification service called, which supports multi-channel alerts.. It will feature a unified REST API, dynamic templating, and delivery tracking.

PR 1 Plan | Week 1

Project Setup, Health Check, and Email Notification Flow

---

Description

• Initialized GoFr project with a clean three-layer architecture:- handler/, service/, and store/ packages
• Set up the foundational project structure and basic config files
• Implemented the Health Check endpoint:
  • GET /health — Returns service liveness status
• Developed initial Notification API:
  • POST /notify — Accepts a request with a target email and message template, dispatches via SMTP.
• Added basic Go templating support for rendering messages with dynamic placeholders
• Integrated golangci-lint for linting
• Set up a CI workflow to automatically run tests and lint checks on pull requests.

---

Deliverables

• GET /health confirms service is up and SMTP connection is successful
• POST /notify handles basic Email delivery using the EmailNotifier
• Message rendering using Go’s text/template engine
• Unit tests for email dispatch and basic template rendering logic
• CI pipeline running successfully on each push
• Basic project documentation included (setup instructions + API reference)

---

Would love to hear your feedback on the plan before I begin.
Thanks!

[coolwednesday]

Add me as an collaborator for the same for PR reviews.

[Kake27]

I have sent the invite.

[Kake27]

Hello, I have made the first commit in which I have set up the overall project structure and added the email notification endpoint (using MailHog SMTP for local testing). Could you please go through it and suggest changes regarding better project structure or using some other SMTP service?

[coolwednesday]

Hey Please tag me everytime you message. So that I get a notification.

[coolwednesday]

Sure Checking it out.

[coolwednesday]

Hey @Kake27

Created an issue. Please address it.

Kake27/gofr-notification-system#1