kramerbot

Kramer's Deals

@kramerbot

https://t.me/kramerbot

A Telegram bot to get you the latest deals from websites like https://www.ozbargain.com.au and https://amazon.com.au. Let Kramer watch deals so you don't have to. Giddy up!

Features

1. Uses Telegram Bot API for instant notifications
2. Written in Go and can be deployed with a single binary (Dockerfile included)
3. Subscribe to good deals, super deals or setup your own custom deals by watching specific keywords
4. User data is written to a Mongo NoSQL database for easy migration (formerly Sqlite)
5. Keep track of deals already sent to avoid duplicate sending
6. Supports scraping www.ozbargain.com.au - Good and super deals
7. Supports scraping www.amazon.com.au (via Camel Camel Camel RSS) - Top daily and weekly deals
8. Supports Android TV notifications
9. API to access user and deal data
10. Ability to send maintenance messages / announcements to all users
11. Slick web app to manage user preferences https://www.github.com/intothevoid/kramerbotui

API

The following API endpoints are available -

/users - Get user data for all users
/users/:chatid - Get user data by chat id
/deals - Get deal data for latest deals by the scraper
/signup - Signup from accompanying web app https://www.github.com/intothevoid/kramerbotui
/preferences - Update user preferences
/authenticate - User authentication

Deployment

You must have the required environment variables for Kramerbot to function correctly. See section 'Required environment variables' for more details. Kramerbot can be deployed using the foll. command, after required environment variables have been set -

go build .
./kramerbot

Required environment variables

TELEGRAM_TOKEN_API=<your_token>
GIN_MODE=release
KRAMERBOT_ADMIN_PASS=<your_admin_password>

Setup MongoDB

sudo docker pull mongo:4.4.18
cd scripts
sudo ./start_mongo.sh

Using Docker

To build a Docker image of Kramerbot use the command -

sudo docker build -t kramerbot:latest .

Create a token.env file with your Telegram API token (used in step below) -

TELEGRAM_TOKEN_API=<your_token>
GIN_MODE=release
KRAMERBOT_ADMIN_PASS=<your_admin_password>

To deploy your container, use the command -

cd scripts
sudo ./start_kramer.sh