No description
Find a file
Miguel de la Cruz 38e78cc02b Update README.md
2023-07-02 08:00:28 +00:00
cmd/birthdaybot Adds basic telegram notification config 2023-07-01 17:48:10 +02:00
model Adds basic telegram notification config 2023-07-01 17:48:10 +02:00
notification Complete notification service interface with notify method 2023-07-01 18:03:15 +02:00
parser Add a test for the CSV parser and check errors on the read config 2023-06-30 09:51:34 +02:00
server Adds telegram notification service and notifications services scaffold 2023-07-01 18:00:48 +02:00
.envrc Initial commit 2023-06-29 18:55:13 +02:00
.gitignore Add example config file 2023-06-30 10:42:27 +02:00
.gitlab-ci.yml Add a check for gomod 2023-06-30 09:54:52 +02:00
birthdays.csv Create a sample birthday.csv file 2023-06-30 11:38:03 +02:00
example-config.yml Add example config file 2023-06-30 10:42:27 +02:00
go.mod Update go version 2023-06-30 17:23:36 +02:00
go.sum Adds a bit of structure 2023-06-29 23:46:17 +02:00
Makefile Adds simple workers start/stop methods 2023-07-01 17:23:19 +02:00
README.md Update README.md 2023-07-02 08:00:28 +00:00
shell.nix Pin dependencies to a nixpkgs commit 2023-06-30 17:23:01 +02:00

pipeline status

Birthday bot

A simple bot that notifies of birthdays, posting the contact information of the subject so you can reach them easily.

Configuration

There is an example configuration file that can be used as a base to create your own configuration, and there is a birthdays example CSV file to load the data.

Run the bot

To get help for the bot command, run:

$ ./birthdaybot -help
Usage of ./birthdaybot:
  -config string
        path to the configuration file (default "birthdaybot.yml")

To run the server with the development defaults, run:

$ make run

Roadmap

  • Create the bot scaffold
  • Define how to read the birthdays info
  • Add a logger instance to the config
  • Add config validation on server creation
  • Add options to the server
  • Pass logger to the server through an option
  • Create a configurable template to fill with each notification
  • Create different message systems to use with the bot
  • Reduce logger verbosity
  • Enjoy!