You will need to create an .env file on the root dir, you can use a sample env file called .env.sample on the root dir, an easy way of doing this is just to copy the sample file to .env.

cp .env-sample .env

You will need to have mongo installed and fill the mongo variables on the .env file, those that stats with DB_.

You will need a telegram bot api key (BOT_TOKEN), find out more about it here.

You can route the bot API via Tor service or another proxy if you specify 'SOCKS_PROXY_HOST' parameter in .env. For Ubuntu see this

Please choose one of these two methods for your setup.

To install just run:

$ npm install

Here we have a detailed guide for installation and first steps using the bot.

$ npm start

$ npm test