mirror of
https://github.com/abocn/TelegramBot.git
synced 2025-03-11 13:19:57 +00:00
31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
# Lynx (Node.js Telegram Bot)
|
|
Lynx is a a simple Telegram bot made in Node.js.
|
|
|
|
## Requirements
|
|
- A Telegram bot (create one at [@BotFather](https://t.me/botfather))
|
|
- Node.js 20 LTS (or above)
|
|
- node-telegram-bot-api (install with ``npm install node-telegram-bot-api``)
|
|
|
|
## Notes
|
|
- The source code itself of the bot is at ``src/main.js``, and the commands are in ``src/commands``.
|
|
- You can rename this file and change the ``package.json`` file as your needs.
|
|
- The name of the command file will always be the command itself.
|
|
- Example: ``whois.js`` will always be ``/whois`` on Telegram.
|
|
|
|
## Develop or contribute with Lynx
|
|
First, [make a fork of this repo](https://github.com/lucmsilva651/lynx/fork), or clone it with
|
|
```
|
|
git clone https://github.com/lucmsilva651/lynx
|
|
```
|
|
Next, go to the repository directory, create a ``config.env`` file and put the content below:
|
|
```
|
|
# insert your bot token here
|
|
# get it with @BotFather on Telegram
|
|
TGBOT_TOKEN=0000000000:AAAaaAAaaaaAaAaaAAAaaaAaaaaAAAAAaaa
|
|
```
|
|
Put your bot token that you created at [@BotFather](https://t.me/botfather) at the variable ``TGBOT_TOKEN`` (as the example above) and save the file.
|
|
|
|
At last, run the bot with ``npm start``.
|
|
|
|
## About/License
|
|
MIT - 2024 Lucas Gabriel (lucmsilva). |