https://github.com/josestg/raccoonjs-api
A simple nodejs module to interact with Telegram Bot API.
https://github.com/josestg/raccoonjs-api
Last synced: about 1 month ago
JSON representation
A simple nodejs module to interact with Telegram Bot API.
- Host: GitHub
- URL: https://github.com/josestg/raccoonjs-api
- Owner: josestg
- License: mit
- Created: 2020-01-23T04:54:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T05:42:29.000Z (over 2 years ago)
- Last Synced: 2025-03-18T12:53:34.803Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://josestg.github.io/raccoonjs-api/index.html
- Size: 1.27 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
Raccoonjs API
A simple nodejs module to interact with Telegram Bot API.
[](https://travis-ci.org/josestg/raccoonjs-api)
## Install
```bash
$ yarn add raccoonjs-api
```
or
```bash
$ npm i raccoonjs-api
```
## Documentation
See **raccoonjs-api** documentation [here](https://josestg.github.io/raccoonjs-api/).
## Tutorial
In this tutorial we will first use `localhost` as a server to develop the Telegram bot, but at the end of this tutorial we will try to change `localhost` to [Heroku](https://dashboard.heroku.com/) as a server.
### Exposing localhost to the internet
In order for bots to receive incoming updates from the Telegram server, `localhost` needs to be exposed to the internet using [Ngrok](https://ngrok.com/).
```bash
$ ngork http
```
In this tutorial we use `PORT = 5000`
### Coding
Here we will make a simple bot that makes the bot can respond back when the user sends **certain commands** to the bot. For example, when a user sends a message like this `"/hello"`, the bot will respond `"Hello, "`
1. Create Project
```bash
$ mkdir example && cd example
```
2. Init Nodejs Project
```bash
$ npm init --yes
```
3. Install Raccoonjs-api
```bash
$ npm install raccoonjs-api
```
4. Create App
```bash
$ touch index.js
```
5. Open Project with Text Editor ([vscode](https://code.visualstudio.com/))
```
$ code .
```
6. Write a simple bot
```js
// index.js
// import the module
const { TelegramAPI } = require("raccoonjs-api");
// A unique authentication token see: https://core.telegram.org/bots/api#making-requests
const YOUR_TOKEN = "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11";
// Ngrok forwarding secure url (prefix with 'https')
const YOUR_HOST = "https://.ngrok.io";
const port = 5000;
// create bot instance
const bot = new TelegramAPI(YOUR_TOKEN, YOUR_HOST);
// start the webhook then the bot can receive incoming updates
// it is recommended to use a secret path in the URL, e.g. YOUR_HOST/. Because no one else knows your bot token.
bot.startWebhook("/secretPath", port, () => {
console.log("Webhook started!");
});
// define a command message
bot.cmd("hello", ctx => {
const { chat } = ctx;
bot.sendText(chat.id, `Hello ${chat.first_name}`);
});
```
7. It's time to try
```bash
$ node index.js
```
to see the results, try sending the "**/hello**" message to the bot and see the magic!
### Deploy to Heroku
Follow the official tutorial from Heroku. [Deploying Node.js Apps on Heroku](https://devcenter.heroku.com/articles/deploying-nodejs)
**Note:**
Because this bot application is not a web application, but a process it is necessary to add the following script to the Procfile file.
```Procfile
worker: node index.js
```
**Note:**
Before actually deploying an application to Heroku it is recommended to save variables such as **token** or **other credentials** to the environment variables. [See.](https://devcenter.heroku.com/articles/config-vars)
## Special Thanks
**[PT Privy Identitas Digital (PrivyID)](https://privy.id/)**
Thanks for giving the internship opportunity as a Back End Developer, this project began when PrivyID gave the task of making a Telegram bot to assist in the Stand-up Meeting.
## Inspiration
**[Node Telegram Bot API](https://github.com/yagop/node-telegram-bot-api)**
## License
[MIT](https://github.com/josestg/raccoonjs-api/blob/master/LICENSE)