Open in Telegram
or
just type @ScanToolBot in message input field

• Scan QR codes with a camera
• Generate QR codes
• Works in any chat via inline mode

1. Close repository:

git clone git@github.com:bot-base/scan-tool-bot.git

2. Create an environment variables file:

cp .env.example .env

3. Launch web app following the instructions in webapp/README.md.

4. Set BOT_TOKEN, WEBAPP_URL, API_URL environment variables in .env file.

5. Launch bot

   Development mode:

   # 1. Install dependencies
   npm i
   # 2. Set BOT_SERVER_HOST to localhost
   # Set BOT_SERVER_PORT to any available port
   # 2. Run bot (in watch mode)
   npm run dev

   Production mode:

   # 1. Install dependencies
   npm i --only=prod
   # 2. Set NODE_ENV to production
   # Change BOT_WEBHOOK to the actual URL to receive updates
   # 3. Run bot
   npm start 
   # or
   npm run start:force # if you want to skip type checking

• npm run lint — Lint source code.
• npm run format — Format source code.
• npm run typecheck — Runs type checking.
• npm run dev — Starts the bot in development mode.
• npm run start — Starts the bot.
• npm run start:force — Starts the bot without type checking.