https://github.com/lucasvillarinho/nofy

📬 NoFy is a versatile, zero-dependencies library for sending notifications to popular services
https://github.com/lucasvillarinho/nofy

discord email go golang message notification slack whatsapp

Last synced: 2 months ago
JSON representation

📬 NoFy is a versatile, zero-dependencies library for sending notifications to popular services

• Host: GitHub
• URL: https://github.com/lucasvillarinho/nofy
• Owner: lucasvillarinho
• License: mit
• Created: 2024-07-26T12:35:39.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-29T20:58:04.000Z (3 months ago)
• Last Synced: 2024-10-01T07:23:33.693Z (3 months ago)
• Topics: discord, email, go, golang, message, notification, slack, whatsapp
• Language: Go
• Homepage:
• Size: 207 KB
• Stars: 22
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        

# `📬 NoFy`

✨ `nofy` is a versatile, zero-dependencies library for sending notifications to popular services.

[![Zero Dependencies](https://img.shields.io/badge/Dependencies-Zero-brightgreen.svg)](https://github.com/lucasvillarinho/nofy/blob/main/go.mod) [![Go Report Card](https://goreportcard.com/badge/github.com/lucasvillarinho/nofy)](https://goreportcard.com/report/github.com/lucasvillarinho/nofy) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/ec1e325348344d43906561ec19471598)](https://app.codacy.com/gh/lucasvillarinho/nofy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![codecov](https://codecov.io/github/lucasvillarinho/nofy/branch/main/graph/badge.svg?token=93EO1TC9DB)](https://codecov.io/github/lucasvillarinho/nofy)

 [![Sponsor](https://img.shields.io/badge/Sponsor-❤-ff69b4.svg)](https://github.com/sponsors/lucasvillarinho)

### 💫 Features

> [!WARNING]

>

>API is currently under development. Expect potential changes and unstable behavior.

- **Zero Dependencies**: Lightweight with no external dependencies.

- **Multi-Service Support**: Send notifications to Slack, Discord, Resend, and more.

- **Bulk Messaging**: Send notifications to multiple repositories simultaneously.

- **Extensible**: Easily add more services or custom logic.

### 📦 Installation

#### Install

```sh

go get -u github.com/lucasvillarinho/nofy

```

#### Example

##### Slack

```go

// Create a new Slack messenger

slackMessenger, _ := slack.NewSlackMessenger(

    // Set the Slack token to be used to send (required)

    slack.WithToken("token"),

    slack.WithMessage(

        // Message to be sent to the slack channel (required)

        // The message is a slice of maps, each map represents a block of the message

        // In this case, we are sending a single block with a text section

        slack.Message{

            Channel: "channel",

            Content: []map[string]any{

                {

                    "type": "section",

                    "text": map[string]string{

                        "type": "mrkdwn",

                        "text": "Hello, World!",

                    },

                },

            },

        }))

// Create a new Nofy with the Slack messenger

nofy := nofy.NewWithMessengers(slackMessenger)

// Send the message for all messengers

_ = nofy.SendAll(context.Background())

```

### 💛 Support the author

[![Sponsor](https://img.shields.io/badge/Sponsor-❤-ff69b4.svg)](https://github.com/sponsors/lucasvillarinho)

Enjoying the project? Consider [supporting](https://github.com/sponsors/lucasvillarinho) it to help me keep improving and adding new features!

### 📜 License

 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/lucasvillarinho/nofy/blob/main/LICENSE)

This software is licensed under the [MIT](https://github.com/lucasvillarinho/nofy/blob/main/LICENSE)