Esports-notifier NPM

:trumpet: Overview

Receive a daily email informing whenever at least one of your favorite esports teams has a match on the current date in a bunch of esports games, including csgo, valorant and rainbow six siege.

It is worth mentioning that the tool currently informs about the following games with each respective source:

valorant: vlr.gg
counter-strike global offense: liquipedia
rainbow six siege: liquipedia
league of legends: liquipedia
overwatch: liquipedia
rocket league: liquipedia
dota: liquipedia
call of duty: liquipedia

:dart: Features

✔️ receive a daily email informing whenever at least one of your favorite teams has a match in the current date; ✔️ select the games you are interested in to check for matches; ✔️ option to specify teams per each game; ✔️ specify the time to send the daily email; ✔️ option to inform matches about only the current date or also from the following days.

:warning: Requirements

The only thing you need to use this project is a gmail/google account.

:bulb: Usage

How it works

It basically sets a function to run in google apps scripts to run everyday at a specified time, and this function is responsable for:

get all the the matches scheduled for the next couple of days in all games that you're interested in;
filter the matches list to get only the ones about your favorite teams;
if there's at least one game of your favorite teams, send you an email about informing the details.

The matches list are obtained from a bunch of specialize sites. You can check the corresponding site of everygame by clicking in their links in this section.

Installation

To effectively use this project, do the following steps:

Updating

To update your esports-notifier instance and use the latest features, you just need to change the version number in the getEsportsNotifier function, as it is shown bellow:

So if your instance is running at version "1.0.0" and the latest is "3.6.1", just replace those numbers in the version variable.

It is a good practice to go to the dist folder everytime you update your instance to check if your files in GAS have same properties as the new version; if they're not this may cause errors.

Uninstall

If you want to receive the daily emails, just go to the GAS respective project in the header dropdown menu select the uninstall function and then click on the Run button. By doing that, the GAS trigger responsable for running everyday the function will be deleted.

:wrench: Development

Development setup

# Clone this repository
$ git clone https://github.com/lucasvtiradentes/esports-notifier

# Go into the repository
$ cd esports-notifier

# Install dependencies
$ npm install

Used technologies

This project uses the following thechnologies:

:books: About

twitch-notifier: get email notifications when only your favorite twitch streamers go live.
cheerio for GAS: project used in order to parse the html pages content into javascript objects.
GAS docs: documentation related to triggering functions in Google Apps script.

License

This project is distributed under the terms of the MIT License Version 2.0. A complete version of the license is available in the LICENSE file in this repository. Any contribution made to this project will be licensed under the MIT License Version 2.0.

Feedback

If you have any questions or suggestions you are welcome to discuss it on github issues or, if you prefer, you can reach me in my social media provided bellow.