https://github.com/kevinfjiang/birthdayslackbot
Slackbot to notify and send gifts on birthdays
https://github.com/kevinfjiang/birthdayslackbot
aws aws-lambda google-sheets slack-bot terraform
Last synced: about 2 months ago
JSON representation
Slackbot to notify and send gifts on birthdays
- Host: GitHub
- URL: https://github.com/kevinfjiang/birthdayslackbot
- Owner: kevinfjiang
- License: mit
- Created: 2021-08-24T01:07:45.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-01T19:45:44.000Z (over 3 years ago)
- Last Synced: 2025-01-11T19:44:45.985Z (3 months ago)
- Topics: aws, aws-lambda, google-sheets, slack-bot, terraform
- Language: Go
- Homepage:
- Size: 16 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Birthday Notify Bot
> **Get insta notified and send gifts to your co-workers without the fee**
### **Premise:**
For an NGO I work for, we loved having the slackbot notify us of specific birthdays. Recently, that service ended and the creators have requested $2 per user per month for the bot. For our team of over 100+, that'd adds up to $2400 a year, which is about half the profit we make annually. I have a free alternative that is relatively easy to set up for less techy people that want a slack birthday bot
### **Setup:**
- [ ] Complete setup guide
### **Tech/Design choices:**
Ignore if you're uninterested in the tech
The purpose of the project is that it is not intended to scale because then it would go over the AWS free tier and would seize to be free.
**Golang**: I used and wanted to write a project in it because I've previously worked with it heavily in server side applications. The Go iteractions with Google cloud services are very fast. Also the many post requests made to send slack chats benefit from concurrenncy
**Google sheets**: Very easy to use and set up with a google form. Also, can be used as a database for birthdays and other public info in order
**AWS lambda**: Lambda is free always while EC2 is oonly free for the first twelve months
**AWS DynamoDB**: The interactive messages allow a user to send a url/message to the birthday person and stores it in the DB. The key<>document database makes it easy to pull up the info for the specific birthday person and ssend the information. Ideally, would use AWS Keyspaces but the free trial is monthly for Keyspaces instead of the flat 25 GB for AWS DynamoDB
**Terraform**: Makes it easy to partition resources quickly for new users for the cloud services
### **TODO:**
#### Personal stuff for Kevin to organize and show what's currently accocmplished in the project
Project TODOs
**Admin stuff/documentation**
- [ ] Complete ReadMe
- [x] Remove my environment variables
- [X] Document environment variables
- [x] Set up AWS Credentials
- [x] Set up google cloud credentials
- [X] Finish Google form template/Google sheets template
- [ ] Robustness thorough and document errors page
**Code stuff**
- [x] Randoomize birthday messages, including multiple BDAY messages
- [x] Enable connection and reading to a google sheets as a database that can be used by non-coders
- [x] Implement fibonnaci heap for faster access and reduce search times
- [x] Set up slack notifications with auth token and an app
- [ ] Enable private messaging and pre-birthday private messages
- [x] Set up public messaging and the creatioon of a "Birthday" channel
- [x] Set up template for the slackbot (auth token and permissions)
- [X] Enable Google sheets writes
- [x] Use terraform to set up DB
- [x] Use terraform to set up lambda
- [x] Automate github workflow(kinda)
- [X] MILESTONE: MVP read and writes supported!!!
- [X] Set up http request, exposes the api end point,
- [ ] Personalize/interactive special messages
- [ ] Add logger support
- [ ] Set up DB Reads/Writes
- [ ] Write some unittests
- [ ] Set up github workflows
- [ ] set up CI/CD with an s3 bucket
- [X] Set up DynamoDB for interactive messages
- [ ] "interactive" demo for recruiters ig