https://github.com/dlemel8/daily_tip_bot

A slack bot that publish a technical tip once a day
https://github.com/dlemel8/daily_tip_bot

cronjob golang heroku-app postgresql slack

Last synced: 11 days ago
JSON representation

A slack bot that publish a technical tip once a day

• Host: GitHub
• URL: https://github.com/dlemel8/daily_tip_bot
• Owner: dlemel8
• Created: 2019-12-12T21:26:04.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-08-11T19:33:37.000Z (over 4 years ago)
• Last Synced: 2023-03-01T06:22:39.345Z (almost 2 years ago)
• Topics: cronjob, golang, heroku-app, postgresql, slack
• Language: Go
• Homepage:
• Size: 102 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Daily Tip Bot

This bot is designed to run on Heruku free plan account.

![Design](design.jpg?raw=true "Design")

Since free apps sleep automatically after 30 mins of inactivity, this bot contains 2 services:

1. Interactive service wakes up on Slack event or first command, serve user commands and schedule tips for them on a given hour of day.

2. Scheduled service wakes up some external scheduler event, and send tips to all relevant users that schedule tip for that hour.  

Separation between services is done using sub command. 

### Slack Setup

* Create new app

* Add Bot Token Scopes:

  - commands

  - chat:write

  - users:read

* Define Slash Commands:

  - Command: /get-tip

    - Request URL: will be filled later

    - Short Description: get an immediate tip from selected tips source

    - Usage Hint: [topic]

  - Command: /list-topics

    - Request URL: will be filled later

    - Short Description: list all tip topics

    - Usage Hint: 

  - Command: /schedule-tip

    - Request URL: will be filled later

    - Short Description: schedule an hour in day (0-23) to send a tip 

    - Usage Hint: [hour] [topic]

* Install the app in your workspace

 

### Environment Variables

* PORT - Local listening port (interactive service only). Commands are served under /slack endpoint.

* SLACK_SIGNING_SECRET - App Signing Secret (interactive service only)

* SLACK_BOT_TOKEN - App Bot User OAuth Access Token (starts with xoxb)

* DATABASE_URL - PostgreSql connection string

### Local Development & Testing

* Run testing DB and ngrok using `docker-compose up -d`

* Open ngrok management website (local port 4040) and copy tunnel http url to all Slash commands Request URL field.

* Run interactive service using `daily_tip_bot` or `daily_tip_bot web_server`, where:

  - PORT is set to 8080

  - DATABASE_URL is set to postgres://test:test123@localhost:5432/scheduled_tips?sslmode\=disable

* Run scheduled service using `daily_tip_bot scheduled_tips_sender` (use same DATABASE_URL)

### Heroku Deployment

* Create new app

* Configure resources:

  - Heroku Postgres

    - Plan : hobby-dev

  - Heroku Scheduler

    - Schedule: Every 10 minutes

    -  Run Command: `bin/daily_tip_bot scheduled_tips_sender`

* Connect to Github and set Automatic deploys

* Set all env vars under Config Vars (PORT is automatically set by Heroku)

* Copy app url to all Slash commands Request URL field.