statusbot

command module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 16, 2024 License: Apache-2.0 Imports: 1 Imported by: 0

README

Statusbot

Overview

The Status Bot is a tool designed to send a reminder at specific time

Getting Started

Prerequisites

Ensure that you have installed:

  • Go programming language (version 1.21 or higher if not using docker)
  • Git
How to start
  1. Clone this repository to your local machine:
git clone https://github.com/codescalers/statusbot
cd statusbot 
  1. Setup your telegram bot and your env
  1. Run the bot:
  • Using go
go run main.go -b <your bot token> -t <notfication time (default to 17:00)> -z <timezone (default Africa/Cairo)> -d <path to database (default ~/.statusbot)>
  • Using Docker
docker build -t statusbot .
docker run -e STATUSBOT_TOKEN=<your bot token> -e NOTFICATION_TIME=<notfication time> -e TIMEZONE=<timezone> -e DATABASE=<path to database>-it statusbot

Create a bot

  • Open telegram app
  • Create a new bot
1. Find telegram bot named "@botfarther"
2. Type /newbot
  • Get the bot token
1. In the same bot named "@botfarther"
2. Type /token
3. Choose your bot

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
bot
internal package starts the bot and manages the internals of it
internal package starts the bot and manages the internals of it
db

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL