Skip to content

Latest commit

 

History

History
143 lines (104 loc) · 4.07 KB

README.md

File metadata and controls

143 lines (104 loc) · 4.07 KB
Raw
Beetube

A telegram 🤖 bot for music, videos, movies, EDM tracks, torrent downloads, files and more.

https://t.me/beetube_bot https://t.me/beetubers Beetube CI License: MIT

Table of Content

Demo

The deployed version can be found on telegram as @beetube_bot

Features

  • Browse, search and download movies, music, anime and torrent
  • Ability to browse music sorted by genre
  • Ability to download music directly from chat
  • Ability to paginate all returned results
  • Supports personalized configurations

Installation

Beetube by default have been setup for easy deployment on heroku

Requirements

  • Nodejs >= v14.x
  • MongoDB (database)
  • Have node-raspar deployed and note the server address

Telegram Setup (required)

  1. Create a new bot via @BotFather and note the token
  2. Type /setcommands
  3. Select the bot you just created
  4. Copy and paste the texts below as the bot's commands
  start - start a conversation with the bot
  search - search through any category
  keyboard - show custom keyboard
  about - about this bot

Install on Local Machine

$ git clone https://github.com/kodjunkie/beetube-bot.git
$ cd beetube-bot
$ cp .env.example .env # update .env accordingly
# install dependencies
$ npm install
# have mongodb daemon running
# start the bot
$ npm start

Installation via Docker

$ git clone https://github.com/kodjunkie/beetube-bot.git
$ cd beetube-bot
$ cp .env.example .env # update .env accordingly
#
# build the container
$ docker build -t beetube-bot .
# run the container
$ docker run --name beetube --env-file=.env -it beetube-bot

Installation via Docker Compose

$ git clone https://github.com/kodjunkie/beetube-bot.git
$ cd beetube-bot
$ cp .env.example .env # update .env accordingly
#
# To boot-up first time only
# Or whenever docker file is modified (builds the container)
$ docker compose up --build
# To boot-up without building the container (regular use)
$ docker compose up
# To shut-down
$ docker compose down

Liked it?

Hope you liked this project, don't forget to give it a star ⭐

Tests

$ npm test

# via docker
$ docker exec -it beetube npm test

License

This project is opened under the MIT 2.0 License which allows very broad use for both academic and commercial purposes.