{"id":15056607,"url":"https://github.com/bastean/tgo","last_synced_at":"2026-02-22T02:34:18.654Z","repository":{"id":255436657,"uuid":"837715167","full_name":"bastean/tgo","owner":"bastean","description":"Telegram Got.","archived":false,"fork":false,"pushed_at":"2024-08-30T12:10:01.000Z","size":2213,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-14T06:44:19.854Z","etag":null,"topics":["cassandra","coingecko-api","echo","fomantic-ui","go","telebot","templ","tgo"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bastean.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-03T19:56:28.000Z","updated_at":"2024-08-30T11:37:56.000Z","dependencies_parsed_at":"2024-08-31T05:19:08.407Z","dependency_job_id":null,"html_url":"https://github.com/bastean/tgo","commit_stats":null,"previous_names":["bastean/tgo"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/bastean/tgo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bastean%2Ftgo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bastean%2Ftgo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bastean%2Ftgo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bastean%2Ftgo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bastean","download_url":"https://codeload.github.com/bastean/tgo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bastean%2Ftgo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29703771,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T23:35:04.139Z","status":"online","status_checked_at":"2026-02-22T02:00:08.193Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cassandra","coingecko-api","echo","fomantic-ui","go","telebot","templ","tgo"],"created_at":"2024-09-24T21:54:03.132Z","updated_at":"2026-02-22T02:34:18.617Z","avatar_url":"https://github.com/bastean.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n\n\u003c!-- [![README Logo](https://raw.githubusercontent.com/bastean/tgo/main/assets/readme/logo.png)](https://github.com/bastean) --\u003e\n\n[![README Logo](assets/readme/logo.png)](https://github.com/bastean/tgo)\n\n\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\u003e Example of interoperability between a Web App, a Telegram Bot and a third-party API.\n\n\u003c/div\u003e\n\n\u003e [!IMPORTANT]\n\u003e\n\u003e - `tGO` is still in the early stages of development.\n\n\u003cbr /\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n[![Go Report Card](https://goreportcard.com/badge/github.com/bastean/tgo)](https://goreportcard.com/report/github.com/bastean/tgo)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://github.com/commitizen/cz-cli)\n[![Release It!](https://img.shields.io/badge/%F0%9F%93%A6%F0%9F%9A%80-release--it-orange.svg)](https://github.com/release-it/release-it)\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![Upgrade workflow](https://github.com/bastean/tgo/actions/workflows/upgrade.yml/badge.svg)](https://github.com/bastean/tgo/actions/workflows/upgrade.yml)\n[![CI workflow](https://github.com/bastean/tgo/actions/workflows/ci.yml/badge.svg)](https://github.com/bastean/tgo/actions/workflows/ci.yml)\n[![Release workflow](https://github.com/bastean/tgo/actions/workflows/release.yml/badge.svg)](https://github.com/bastean/tgo/actions/workflows/release.yml)\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![Go Reference](https://pkg.go.dev/badge/github.com/bastean/tgo.svg)](https://pkg.go.dev/github.com/bastean/tgo)\n[![GitHub Releases](https://img.shields.io/github/v/release/bastean/tgo.svg)](https://github.com/bastean/tgo/releases)\n\n\u003c/div\u003e\n\n## Showcase\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"assets/readme/desktop-home.png\" /\u003e\n\n\u003c/div\u003e\n\n## CLI\n\n### Installation\n\n```bash\ngo install github.com/bastean/tgo/cmd/tgo@latest\n```\n\n### Usage\n\n\u003e [!NOTE]\n\u003e\n\u003e - We need to create an `.env` file where we have our own values defined.\n\u003e   - In the [.env.example.cli](deployments/.env.example.cli) file, we can see the values that can be used.\n\u003e     - 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.\n\u003e - Following these step-by-step guides we will get the required values for third-party services like `Telegram` and `CoinGecko`.\n\u003e   - [\"BotFather, creating and managing bots\"](https://core.telegram.org/bots/features#botfather), we will get our authentication token for our `Telegram Bot`.\n\u003e   - [\"Setting Up Your API Key\"](https://docs.coingecko.com/v3.0.1/reference/setting-up-your-api-key), we will get our `CoinGecko` demo key.\n\n```bash\ntgo -h\n```\n\n```text\n_____  ________________\n__  /_ __  ____/__  __ \\\n_  __/ _  / __  _  / / /\n/ /_   / /_/ /  / /_/ /\n\\__/   \\____/   \\____/\n\nExample of interoperability between a Web App, a Telegram Bot and a third-party API.\n\nUsage: tgo [flags]\n\n  -env string\n    \tPath to ENV file (required)\n```\n\n## Docker\n\n### Usage (Demo)\n\n\u003e [!NOTE]\n\u003e\n\u003e - We must define our own `Telegram` and `CoinGecko` values in the file [.env.demo](deployments/.env.demo) by modifying the variables `TGO_BOT_TELEGRAM_*` and `TGO_API_COINGECKO_*`.\n\u003e   - 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.\n\u003e - Following these step-by-step guides we will get the required values for third-party services like `Telegram` and `CoinGecko`.\n\u003e   - [\"BotFather, creating and managing bots\"](https://core.telegram.org/bots/features#botfather), we will get our authentication token for our `Telegram Bot`.\n\u003e   - [\"Setting Up Your API Key\"](https://docs.coingecko.com/v3.0.1/reference/setting-up-your-api-key), we will get our `CoinGecko` demo key.\n\n```bash\nmake demo\n```\n\n## Workflow\n\n### Idea\n\nThe 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.\n\n### Functionality\n\nIt 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.\n\n## First Steps\n\n### Clone\n\n#### HTTPS\n\n```bash\ngit clone https://github.com/bastean/tgo.git \u0026\u0026 cd tgo\n```\n\n#### SSH\n\n```bash\ngit clone git@github.com:bastean/tgo.git \u0026\u0026 cd tgo\n```\n\n### Initialize\n\n#### Locally\n\n1. System Requirements\n\n   - [Go](https://go.dev/doc/install)\n   - [Node](https://nodejs.org/en/download)\n   - [Make](https://www.gnu.org/software/make)\n   - [Docker](https://docs.docker.com/get-docker)\n\n2. Run\n\n   ```bash\n   make init\n   ```\n\n### ZIP\n\n1. [System Requirements](#locally)\n\n2. Run\n\n   ```bash\n   make genesis\n   ```\n\n### Run\n\n#### ENVs\n\n\u003e [!IMPORTANT]\n\u003e Before running it, we must initialize the following environment variable files:\n\u003e\n\u003e - [.env.example](deployments/.env.example)\n\u003e   - We will have to create a `.env.(dev|test|prod)` for each runtime environment.\n\u003e   - In the [.env.example.demo](deployments/.env.example.demo) file, we can see the values that can be used.\n\u003e\n\u003e 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:\n\u003e\n\u003e - [.env.example.test.integration](deployments/.env.example.test.integration)\n\u003e   - Rename the file to `.env.test.integration`.\n\u003e - [.env.example.test.acceptance](deployments/.env.example.test.acceptance)\n\u003e   - Rename the file to `.env.test.acceptance`.\n\n#### Development\n\n```bash\nmake compose-dev\n```\n\n#### Tests\n\n##### Unit\n\n```bash\nmake test-unit\n```\n\n##### Integration\n\n```bash\nmake compose-test-integration\n```\n\n##### Acceptance\n\n```bash\nmake compose-test-acceptance\n```\n\n##### Unit / Integration / Acceptance\n\n```bash\nmake compose-tests\n```\n\n#### Production\n\n```bash\nmake compose-prod\n```\n\n## Tech Stack\n\n#### Base\n\n- [Go](https://go.dev)\n- [Telebot](https://github.com/tucnak/telebot)\n- [Echo](https://echo.labstack.com)\n- [templ](https://templ.guide)\n  - [Fomantic-UI](https://fomantic-ui.com)\n- [Cassandra](https://gocql.github.io)\n- [CoinGecko API](https://www.coingecko.com/api)\n\n#### Please see\n\n- [go.mod](go.mod)\n- [package.json](package.json)\n\n## Contributing\n\n- Contributions and Feedback are always welcome!\n  - [Open a new issue](https://github.com/bastean/tgo/issues/new/choose)\n\n## License\n\n- [MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbastean%2Ftgo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbastean%2Ftgo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbastean%2Ftgo/lists"}