gocryptobot

command module
v0.0.0-...-0a33434 Latest Latest
Warning

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

Go to latest
Published: Dec 2, 2021 License: MIT Imports: 10 Imported by: 0

README

CRYPTO-TELEGRAM-BOT

· Report Bug · Request Feature ·

Gocryptobot is a simple Telegram bot to get historical prices for any crypto currency at your finger tips. It's written in Golang with Telebot's Framework

⭐ Getting started

What you will need:

  • You are going to need a computer or server where to host the bot.
  • Git
  • Golang v1.13
  • A device with Telegram

💻 Installation

Open a Terminal and copy these commands (Linux & Mac devices):

cd ~
git clone https://github.com/sanjaysans/gocryptobot.git
cd ./gocryptobot
mv .env.example .env
go get github.com/sanjaysans/gocryptobot
go run main.go
Warning:

This won't work unless you replace the REPLACE_WITH_TOKEN on the .env file with the Token granted by @BotFather

✅ Create new bot to your Telegram Channel

Open @BotFather on telegram and create a new bot with it's /newbot command.

Assign it a name. This name won't be the one that is shown on each message, so you can name it whatever you want.

@BotFather will grant you a Token. This token is the one that will replace the REPLACE_WITH_TOKEN on the .env.example file on this repository. (Don't forget to rename that file to .env)

You can also play a little bit more with @BotFather. For example you can use the /setcommands to define the uses your bot has on the '/' icon:

start - Gets welcome text and commands list
price - Gets current price for any crypto currency (/price eth)
historic - Gets historic price details for any crypto currency (/historic eth)
help - Gets list of available commands

🔋 Usage

Once the bot is running and added to your Telegram Group, you can use any of the following commands:

    * \start - Gets welcome text and commands list
    * \price - Gets current price for any crypto currency (/price eth)
    * \historic - Gets historic price details for any crypto currency (/historic eth)
    * \help - Gets list of available commands

🏗 Contribution Guidelines:

  • fork and clone this repository
  • Make a new branch using git checkout -b change/username
  • Commit the desired changes to that branch
  • Sign off your commits using git commit -s -m w/signoff
  • Push your changes to the branch and open a pull request

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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