{"id":13772742,"url":"https://github.com/bot-base/scan-tool-bot","last_synced_at":"2025-06-14T08:10:27.920Z","repository":{"id":39110780,"uuid":"485816705","full_name":"bot-base/scan-tool-bot","owner":"bot-base","description":"Scan and create QR codes in Telegram","archived":false,"fork":false,"pushed_at":"2024-05-06T07:27:44.000Z","size":499,"stargazers_count":31,"open_issues_count":2,"forks_count":7,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-05-06T08:39:29.057Z","etag":null,"topics":["bot","grammy","grammyjs","qrcode","qrcode-generator","qrcode-scanner","telegram","telegram-api","telegram-bot","telegram-bot-api","telegram-web-app"],"latest_commit_sha":null,"homepage":"https://t.me/ScanToolBot","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bot-base.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-04-26T14:15:56.000Z","updated_at":"2024-08-03T17:06:18.754Z","dependencies_parsed_at":"2024-01-13T11:52:37.572Z","dependency_job_id":"5852d6dc-b2d7-444e-9cac-a6ec4739f00f","html_url":"https://github.com/bot-base/scan-tool-bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"bot-base/telegram-bot-template","purl":"pkg:github/bot-base/scan-tool-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bot-base%2Fscan-tool-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bot-base%2Fscan-tool-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bot-base%2Fscan-tool-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bot-base%2Fscan-tool-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bot-base","download_url":"https://codeload.github.com/bot-base/scan-tool-bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bot-base%2Fscan-tool-bot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259783067,"owners_count":22910301,"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","grammy","grammyjs","qrcode","qrcode-generator","qrcode-scanner","telegram","telegram-api","telegram-bot","telegram-bot-api","telegram-web-app"],"created_at":"2024-08-03T17:01:07.403Z","updated_at":"2025-06-14T08:10:27.906Z","avatar_url":"https://github.com/bot-base.png","language":"TypeScript","readme":"\u003ch1 align=\"center\"\u003e🤖 Scan Tool Bot\u003c/h1\u003e\n\n\u003cimg align=\"right\" width=\"35%\" src=\"https://github.com/bot-base/scan-tool-bot/assets/26162440/92e1e035-a3d7-4f0f-b5f8-0c40f96a60ec\"\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://t.me/ScanToolBot\"\u003eOpen in Telegram\u003c/a\u003e\n\u003cbr/\u003e or \n\u003cbr/\u003e\njust type \u003ccode\u003e@ScanToolBot\u003c/code\u003e in message input field\n\n\u003c/p\u003e\n\n## Features\n\n- Scan QR codes with a camera\n- Generate QR codes\n- Works in any chat via inline mode\n\n## Launch\n\n1.  Close repository:\n\n```sh\ngit clone git@github.com:bot-base/scan-tool-bot.git\n```\n\n2.  Create an environment variables file:\n\n```bash\ncp .env.example .env\n```\n\n3.  Launch web app following the instructions in [webapp/README.md](webapp/README.md).\n\n4.  Set BOT_TOKEN, WEBAPP_URL, API_URL [environment variables](#environment-variables) in `.env` file.\n\n5.  Launch bot\n\n    Development mode:\n\n    ```bash\n    # 1. Install dependencies\n    npm i\n\n    # 2. Set BOT_SERVER_HOST to localhost\n    # Set BOT_SERVER_PORT to any available port\n\n    # 2. Run bot (in watch mode)\n    npm run dev\n    ```\n\n    Production mode:\n\n    ```bash\n    # 1. Install dependencies\n    npm i --only=prod\n\n    # 2. Set NODE_ENV to production\n    # Change BOT_WEBHOOK to the actual URL to receive updates\n\n    # 3. Run bot\n    npm start \n    # or\n    npm run start:force # if you want to skip type checking\n    ```\n\n### List of available commands\n- `npm run lint` — Lint source code.\n- `npm run format` — Format source code.\n- `npm run typecheck` — Runs type checking.\n- `npm run dev` — Starts the bot in development mode.\n- `npm run start` — Starts the bot.\n- `npm run start:force` — Starts the bot without type checking.\n\n## Environment Variables\n\n\u003ctable\u003e\n\u003cthead\u003e\n  \u003ctr\u003e\n    \u003cth\u003eVariable\u003c/th\u003e\n    \u003cth\u003eType\u003c/th\u003e\n    \u003cth\u003eDescription\u003c/th\u003e\n  \u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eNODE_ENV\u003c/td\u003e\n    \u003ctd\u003eString\u003c/td\u003e\n    \u003ctd\u003eApplication environment (\u003ccode\u003edevelopment\u003c/code\u003e or \u003ccode\u003eproduction\u003c/code\u003e)\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_TOKEN\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        Token, get it from \u003ca href=\"https://t.me/BotFather\"\u003e@BotFather\u003c/a\u003e.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_WEBHOOK\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        Webhook endpoint, used to configure webhook in \u003cb\u003eproduction\u003c/b\u003e environment.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eWEBAPP_URL\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        HTTPS link to Web App.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eAPI_URL\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        `/api` endpoint (must be public and available to Telegram)\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eLOG_LEVEL\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional.\u003c/i\u003e\n        Application log level. \n        See \u003ca href=\"https://github.com/pinojs/pino/blob/master/docs/api.md#level-string\"\u003ePino docs\u003c/a\u003e for a complete list of available log levels. \u003cbr/\u003e\n        Defaults to \u003ccode\u003einfo\u003c/code\u003e.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_SERVER_HOST\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional.\u003c/i\u003e Server address. \u003cbr/\u003e\n        Defaults to \u003ccode\u003e0.0.0.0\u003c/code\u003e.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_SERVER_PORT\u003c/td\u003e\n    \u003ctd\u003e\n        Number\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional.\u003c/i\u003e Server port. \u003cbr/\u003e\n        Defaults to \u003ccode\u003e80\u003c/code\u003e.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_ALLOWED_UPDATES\u003c/td\u003e\n    \u003ctd\u003e\n        Array of String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional.\u003c/i\u003e A JSON-serialized list of the update types you want your bot to receive. See \u003ca href=\"https://core.telegram.org/bots/api#update\"\u003eUpdate\u003c/a\u003e for a complete list of available update types. \u003cbr/\u003e\n        Defaults to an empty array (all update types except \u003ccode\u003echat_member\u003c/code\u003e).\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_ADMIN_USER_ID\u003c/td\u003e\n    \u003ctd\u003e\n        Number or \u003cbr\u003e Array of Number\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional.\u003c/i\u003e Administrator user ID. Commands such as \u003ccode\u003e/setcommands\u003c/code\u003e will only be available to a user with this ID. \u003cbr/\u003e\n        Defaults to an empty array.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n","funding_links":[],"categories":["Bots"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbot-base%2Fscan-tool-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbot-base%2Fscan-tool-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbot-base%2Fscan-tool-bot/lists"}