README.md

Example of interoperability between a Web App, a Telegram Bot and a third-party API.

Important

• tGO is still in the early stages of development.

Showcase

CLI

Installation

go install github.com/bastean/tgo/cmd/tgo@latest

Usage

Note

• We need to create an .env file where we have our own values defined.
  • In the .env.example.cli file, we can see the values that can be used.
    • If we want only certain users to be able to interact with the bot to “test” it, then we must define their respective usernames in the TGO_BOT_TELEGRAM_WHITELIST_USERNAMES variable, otherwise anyone will be able to interact with it.
• Following these step-by-step guides we will get the required values for third-party services like Telegram and CoinGecko.
  • "BotFather, creating and managing bots", we will get our authentication token for our Telegram Bot.
  • "Setting Up Your API Key", we will get our CoinGecko demo key.

tgo -h

_____  ________________
__  /_ __  ____/__  __ \
_  __/ _  / __  _  / / /
/ /_   / /_/ /  / /_/ /
\__/   \____/   \____/

Example of interoperability between a Web App, a Telegram Bot and a third-party API.

Usage: tgo [flags]

  -env string
    	Path to ENV file (required)

Docker

Usage (Demo)

Note

• We must define our own Telegram and CoinGecko values in the file .env.demo by modifying the variables TGO_BOT_TELEGRAM_* and TGO_API_COINGECKO_*.
  • If we want only certain users to be able to interact with the bot to “test” it, then we must define their respective usernames in the TGO_BOT_TELEGRAM_WHITELIST_USERNAMES variable, otherwise anyone will be able to interact with it.
• Following these step-by-step guides we will get the required values for third-party services like Telegram and CoinGecko.
  • "BotFather, creating and managing bots", we will get our authentication token for our Telegram Bot.
  • "Setting Up Your API Key", we will get our CoinGecko demo key.

make demo

Workflow

Idea

The system allows the user to register a “portfolio” of cryptocurrencies to perform different actions on it, such as consulting the market “prices” of the registered coins.

Functionality

It is a simple monolith where CRUD operations are performed from the Web App and the Telegram Bot to the same database, this allows us to manage users from different applications.

First Steps

Clone

HTTPS

git clone https://github.com/bastean/tgo.git && cd tgo

SSH

git clone [email protected]:bastean/tgo.git && cd tgo

Initialize

Locally

1. System Requirements

   • Go
   • Node
   • Make
   • Docker

2. Run

   make init

ZIP

1. System Requirements

2. Run

   make genesis

Run

ENVs

Important

Before running it, we must initialize the following environment variable files:

• .env.example
  • We will have to create a .env.(dev|test|prod) for each runtime environment.
  • In the .env.example.demo file, we can see the values that can be used.

In case we only want to run the Integration or Acceptance tests, in addition to having the .env.test file, we must have the following files created:

• .env.example.test.integration
  • Rename the file to .env.test.integration.
• .env.example.test.acceptance
  • Rename the file to .env.test.acceptance.

Development

make compose-dev

Tests

Unit

make test-unit

Integration

make compose-test-integration

Acceptance

make compose-test-acceptance

Unit / Integration / Acceptance

make compose-tests

Production

make compose-prod

Tech Stack

Base

• Go
• Telebot
• Echo
• templ
  • Fomantic-UI
• Cassandra
• CoinGecko API

Please see

• go.mod
• package.json

Contributing

• Contributions and Feedback are always welcome!
  • Open a new issue

License

• MIT