HyperText Updater Bot

A Telegram Bot which updates you about anything on the internet!

Use · Report Bug · Request Feature

Table of Contents

• About the Project
• Built With
• Usage
• Contributing
• License
• Contact

About The Project

Built With

• Node.js
• Telegraf
• LowDB

Usage

Visit https://github.com/aayushdutt/telegram-updater-bot to start using the bot.

Installing Locally

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

1. With Docker

Prerequisites

• Docker

Installation/Usage

1. To get a API token, create a new bot at https://telegram.me/BotFather
2. Download the docker-compose.yml file locally.
3. Enter your Bot Token from step 1 in TELEGRAM_BOT_TOKEN= in the docker-compose.yml file.
4. Run docker-compose up -d to run the Bot locally.

2. Without Docker

Prerequisites

• Node.js
• npm

Installation/Usage

1. To get a API token, create a new bot at https://telegram.me/BotFather
2. Clone the repo

git clone https:://github.com/your_username_/Project-Name.git

3. Install NPM packages

npm install

4. Export your Bot Token from step 1 in environment variables (replace yourToken with your own)

export TELEGRAM_BOT_TOKEN=yourToken

5. Run the bot

npm start

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Aayush Dutt - @aayushdutt - [email protected]

Project Link: https://github.com/aayushdutt/telegram-updater-bot