{"id":24038651,"url":"https://github.com/youneslaaroussi/telegram-bot","last_synced_at":"2025-04-10T05:07:52.917Z","repository":{"id":62205184,"uuid":"558785538","full_name":"youneslaaroussi/telegram-bot","owner":"youneslaaroussi","description":"Telegram Bot that greets people, powered by Cyclic. ⚡️","archived":false,"fork":false,"pushed_at":"2023-02-28T14:14:02.000Z","size":4146,"stargazers_count":22,"open_issues_count":0,"forks_count":264,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-10T05:07:42.955Z","etag":null,"topics":["bot","bots","chat","chatbot","serverless","social-media","telegram","telegram-bot","text-effects","unicode"],"latest_commit_sha":null,"homepage":"https://t.me/CyclicDemoBot","language":"TypeScript","has_issues":false,"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/youneslaaroussi.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2022-10-28T09:40:44.000Z","updated_at":"2024-10-01T07:06:03.000Z","dependencies_parsed_at":"2024-10-18T17:52:53.614Z","dependency_job_id":"07ef7fb5-951a-4a69-8989-9b78f18b3005","html_url":"https://github.com/youneslaaroussi/telegram-bot","commit_stats":{"total_commits":3,"total_committers":1,"mean_commits":3.0,"dds":0.0,"last_synced_commit":"1ee78622ec0789667139bb5d4c293c6b1b2fa88f"},"previous_names":["youneslaaroussi/telegram-bot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/youneslaaroussi%2Ftelegram-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/youneslaaroussi%2Ftelegram-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/youneslaaroussi%2Ftelegram-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/youneslaaroussi%2Ftelegram-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/youneslaaroussi","download_url":"https://codeload.github.com/youneslaaroussi/telegram-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248161273,"owners_count":21057555,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["bot","bots","chat","chatbot","serverless","social-media","telegram","telegram-bot","text-effects","unicode"],"created_at":"2025-01-08T20:09:05.343Z","updated_at":"2025-04-10T05:07:52.877Z","avatar_url":"https://github.com/youneslaaroussi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Telegram Bot, built on Cyclic 🤖\n\nSay hello to the Telegram Bot template! Built on the [grammY](https://grammy.dev/) framework and hosted by the [Cyclic](https://www.cyclic.sh/) serverless platform.\n\n- Handling Inline Queries.\n- Responding to commands.\n- Interactive Inline Keyboards.\n\nTry it out now! [\\@CyclicDemoBot](http://t.me/CyclicDemoBot)\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"assets/telegram-bot-banner.png\" alt=\"The Telegram Bot Starter.\" /\u003e\u003c/p\u003e\n\n\n## Deployment\n\n### Prerequisites\n\nMake sure that you have the following programs installed on your own local machine.\n\n- [Telegram Client](https://desktop.telegram.org/).\n- cURL.\n\n### Step 1 — Deploy on Cyclic 🚀\n\nTake your new Telegram bot live with one click. \\\n**Free hosting. No credit card required.**\n\n[![Deploy to Cyclic](https://deploy.cyclic.sh/button.svg)](https://deploy.cyclic.sh/eludadev/telegram-bot)\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"assets/deploying-to-cyclic.gif\" alt=\"Deploying an app to Cyclic\" /\u003e\u003c/p\u003e\n\n### Step 2 — Configure environment variables\n\n1. Grab your Telegram bot's API token by sending a message to [\\@BotFather](https://telegram.me/BotFather).\n\u003cp align=\"center\"\u003e\u003cimg src=\"./assets/creating-telegram-bot-api-token.gif\" alt=\"Send /newbot to @BotFather to create a new bot and get its API token.\" /\u003e\u003c/p\u003e\n\n2. Add that API token to your Cyclic deployment's environment variables.\n\u003cp align=\"center\"\u003e\u003cimg src=\"./assets/setting-api-token-in-cyclic.gif\" alt=\"\" /\u003e\u003c/p\u003e\n\n3. Set the `NODE_ENV` environment variable to `production`.\n\u003cp align=\"center\"\u003e\u003cimg src=\"./assets/setting-node-env-variable.gif\" alt=\"\" /\u003e\u003c/p\u003e\n\n### Step 3 — Link the bot with your new server\n\nConnect your Telegram bot to your server by sending the following HTTP request using your terminal:\n\n#### Linux / MacOS\n\n```bash\nexport TELEGRAM_API_TOKEN=... # YOUR TELEGRAM API TOKEN\nexport TELEGRAM_WEBHOOK_URL=... # YOUR CYCLIC DEPLOYMENT URL\n\ncurl \"https://api.telegram.org/bot$TELEGRAM_API_TOKEN/setWebhook?url=$TELEGRAM_WEBHOOK_URL\"\n```\n\n## How to run it locally?\n\n### Prerequisites\n\n- Node.\n- Yarn.\n- [Telegram Client](https://desktop.telegram.org/).\n\n### Local installation\n\n1. Clone the repository to your machine: `git clone https://github.com/eludadev/telegram-bot \u0026\u0026 cd telegram-bot`\n2. Grab your bot's API token by messaging [\\@BotFather](https://telegram.me/BotFather). (see above)\n3. Create the file `.env` and add the following line:\n```bash\nTELEGRAM_TOKEN=... # YOUR TELEGRAM API TOKEN\n```\n4. Download dependencies: `yarn`\n5. Start your bot: `yarn dev`\n\n## Usage Examples\n\n### Being greeted by the bot\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"assets/bot-greeting.gif\" alt=\"Bot responding to the yo command with \"yo eludadev\"\" /\u003e\u003c/p\u003e\n\n\n### Applying text effects\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"assets/bot-text-effects.gif\" alt=\"Bot applying various text effects such as monospace and italic to the text \"Hello World\"\" /\u003e\u003c/p\u003e\n\n\n### Invoking the bot in other chats\n\n\u003e **Note**\n\u003e This feature is also known as [Inline Queries](https://core.telegram.org/api/bots/inline).\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"assets/bot-inline-queries.gif\" alt=\"Bot applying the monospace text effect to the text \"Hello\" in another chat\" /\u003e\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyouneslaaroussi%2Ftelegram-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyouneslaaroussi%2Ftelegram-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyouneslaaroussi%2Ftelegram-bot/lists"}