Categorygithub.com/kewsor0x/notifier
repositorypackage
0.0.0-20241216233432-6c3db50f54af
Repository: https://github.com/kewsor0x/notifier.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

Notifier - Payment Notifier

Notifier is an application written in Go designed to automatically notify payments using cron jobs. This project allows you to schedule recurring tasks that send notifications about pending payments, payments made or any event related to payments.

Characteristics

  • Automation of payment notifications through cron jobs.
  • Flexible configuration for different execution frequencies.
  • Integration with notification email services.
  • Detailed logs for monitoring and debugging.

Requirements

  • Go 1.20 or higher.
  • Access to a supported MySQL database.
  • Configuration of the cron service to execute recurring tasks.

Installation

  1. Clone this repository:
    git clone https://github.com/rober0xf/notifier.git
    cd notifier
    
  2. Install the dependencyes:
    go mod tidy
    
  3. Configure the env variables in a file .env:
    DB_HOST=localhost
    DB_PORT=5432
    DB_USER=user
    DB_PASSWORD=password
    DB_NAME=notifier
    SMTP_HOST=smtp.example.com
    SMTP_PORT=587
    [email protected]
    SMTP_PASSWORD=your_password
    

Usage

  1. Compile the application:
    go build -o notifier
    
  2. Execute the binary:
    ./notifier
    
  3. Configure a cronjob to execute the application. For example each hour:
    0 * * * * /route/to/notifier >> /var/log/notifier.log 2>&1