jpmoura/telegram-nfl-fantasy-bot

A Telegram bot that provides the latest news about the NFL

NFL & Fantasy News Bot for Telegram 🏈🤖

This is a Telegram bot that provides the latest news about the NFL powered by RotoWire and Twitter accounts and about one NFL Fantasy league at your choice. The bot will fetch info about the NFL and the fantasy league every minute and then it will send to all clients that allowed the bot to do so.

My motto to create this bot came from my frustration to find a reliable service that notifies me about things related to the league. I wanted to know about any player of all teams as soon as possible because I'm a fantasy aficionado and information can be translated into fantasy points in this case.

Requirements

The only requirement it is at least a Node version that bundles the promisify utility (i.e. Node 12)

Using the bot

In order to use this bot you need to create a .ENV file with two specific keys:

• BOT_TOKEN: refers to the bot API token, which one you can get from @BotFather;
• TWITTER_CONSUMER_KEY: refers to the key of your Twitter client;
• TWITTER_CONSUMER_SECRET: refers to the secret token of your Twitter client;
• TWITTER_ACCOUNTS: refers to the accounts from Twitter you wanna get tweets from;
• FANTASY_LEAGUE_ID: refers to the ID of your fantasy league.

You will need to apply for a key in Twitter. After set this .ENV file with these five keys, just run the command yarn && yarn tsc && yarn start.

This bot was built on top of NodeJS v14.

Disclaimer

If you plan to serve this bot to different users and not just for yourself you gonna probably will need a Privacy Police

TODO

• Automatized tests that covers at least 80%;
• Persist the chat ids;
• More elegant message about Fantasy League transactions;
• Allow to add more than one fantasy league to update about it.
• Aggregate posts from NFL @ Instagram;
• Add Web User Interface to set the tokens and leagues ids;
• Dockerfile aiming a simple way to deploy the bot.
• Aggregate tweets from @NFLResearch for real time statistics about the games
• Build a more elegant message, possibly using MarkDown instead using images with caption.

telegram-nfl-fantasy-bot's Issues

Error during startup

Error related to using multiple instances of NEDB datastore for the same file.

Allow tracking more the one fantasy league

Allow tracking of multiples fantasy leagues

Project refactoring

The project need a refactoring to improve its maintainability. Configuration blocks can be extracted to another domain, also utility functions.

Each consumer must have its own module and its responsibility needs to be better delimited.

Incorrect promisify usage

In ChatRepository.ts line 14 the usage of promisify + bind functions is incorrect.

Persist chats IDs

Build a way to store the chats IDs so the bot doesn't loses all the clients already connected

[BUG] Duplicated news

Sometimes when the volume of news reach its peak (e.g. after a round) the bot send the same news multiple times

Update Dockerfile and docs to use Yarn

Update docs and Dockerfile to use Yarn as the package manager instead of NPM

Dockerfile for easy deploy

Creation of a Dockefile that allows any person interested to have your own bot a easy and fast deploy of it

Web interface to management

Creation of a web graphical user interface (Web GUI) to allow a easy management of bot's configuration

Undefined user name in group replies

If the bot is in a group, the /firstdown command does not capture user's first name and send a reply with undefined in its body

Error while parsing news from Rotowire

Bug related to cheerio. It throws a exeception while creating a new Cheerio.Root if the argument is a cheerio.Element

Add NFL Instagram posts

Add a new consumer: NFL posts on Instagram

Convert project to TypeScript

Using strong types, specially on consumers and senders could lead to a better project structure and code

Allow personalized leagues for each client

Allows the client to choose what leagues that he wants to follow the transactions

80% code coverage at least

Build tests that covers at least 80% of the code.

Create GitHub Actions

Add actions for PRs and commits on master branch to run Sonar (SonarCloud) analysis