An open API service indexing awesome lists of open source software.

https://github.com/derogab/clownbot

A telegram bot to cheer up conversations in own chat groups.
https://github.com/derogab/clownbot

bot clown hacktoberfest telegram telegram-bot

Last synced: 5 months ago
JSON representation

A telegram bot to cheer up conversations in own chat groups.

Awesome Lists containing this project

README

          




CLOWNBOT


A telegram bot to cheer up conversations in own chat groups




Docker Pulls




## Introduction
**Birth**: This bot was born for fun purposes in my university group chat.

## Configuration
Copy `.env.tpl` template in `.env` with your info.

## Extra
Copy `extra.js.tpl` template in `extra.js` to add extra features.

## Start
### From source
Install dependencies
```
npm install
```
and then start the bot
```
npm start
```
### Using Docker
##### w/ one-line command
```
docker run \
-dit \
--restart=always \
--mount type=bind,source=/path/to/host/private/,target=/bot/private \
-e "TELEGRAM_BOT_USERNAME=YOUR_BOT_USERNAME_HERE" \
-e "TELEGRAM_BOT_API_TOKEN=YOUR_BOT_TOKEN_HERE" \
-e "TELEGRAM_ALLOWED_USERS=FIRST_ALLOWED_USER_ID,SECOND_ALLOWED_USER_ID,..." \
-e "GIPHY_API_KEY=YOUR_GIPHY_API_KEY_HERE" \
derogab/clownbot
```
Replace `/path/to/host/private/` with absolute path to your private folder (containing extra) and other configs.
##### w/ docker-compose
```
docker-compose up -d
```

### License
_Clownbot_ is made with ♥ by [derogab](https://github.com/derogab) and it's released under the MIT license.