JSPM – esports-notifier@1.0.0

Package Exports

esports-notifier
esports-notifier/dist/EsportsNotifier.min.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (esports-notifier) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ESPORT NOTIFIER

Features • Requirements • Usage • Development • About

see table of content

Features
Requirements
Usage
Development
- Development setup
- Used technologies
About
- Related
- License
- Feedback

🎺 Overview

Get a daily email informing what are the today matches of your favorite teams in a bunche of esports games, including csgo, valorant and league of legends.

Desktop view	Mobile view

🎯 Features

   ✔️ get daily email informing what are your favorite teams today matches;
   ✔️ select the games you are interested in to check for matches;
   ✔️ specify the time to send the daily email;
   ✔️ option to informe matches about only the current date or also from the following days.

Also it is worth mentioning that the tool informs about the following games:

counter-strike global offense
valorant
rainbow six siege const CONFIGS = { esports: { favoriteTeams: ['loud', 'mibr', 'imperial'], // specify your favorite teams games: { // select the games you're interested csgo: true, valorant: true, rainbowSixSiege: true, dota: false, lol: false, rocketLeague: false, overwatch: false, callOfDuty: false, freeFire: false } }, datetime: { timeToSendEmail: '07:00', // time to send the daily email if there is at least on game of your favorite teams diffHoursFromGmtTimezone: -3 // specify the hour difference between your timezone and GMT timezone (UTC 0) }, settings: { notifyOnlyAboutTodayGames: true, // if 'false' it will alse send email in case of matchs of favorite teams in the next days strictTeamComparasion: false, // if 'true' the name of the teams must be exact in all the matches source sites maintanceMode: false, // development option dont need to change loopFunction: 'checkTodayGames' // development option dont need to change } }; function getEsportsNotifier(){ const version = "1.0.0" const content = UrlFetchApp.fetch(`https://cdn.jsdelivr.net/npm/esports-notifier@${version}`).getContentText(); eval(content) const esportsNotifier = new EsportsNotifier(CONFIGS) return esportsNotifier; } function checkTodayGames() { const esportsNotifier = getEsportsNotifier(); esportsNotifier.checkTodayGames(); } function setup() { const esportsNotifier = getEsportsNotifier(); esportsNotifier.install(); } function uninstall() { const esportsNotifier = getEsportsNotifier(); esportsNotifier.uninstall(); }

3 - allow the required google permissions

Go to the project settings by clicking on the first image rectangle. After that, check the option to show the appsscript.json in our project, a file that manages the required google api access.

Go back to the project files, and replace the content present in the appsscript.json with the following code:


{
  "timeZone": "Etc/GMT",
  "dependencies": {
    "libraries": [
      {
        "userSymbol": "Cheerio",
        "version": "14",
        "libraryId": "1ReeQ6WO8kKNxoaA_O0XEQ589cIrRvEBA9qcWpNqdOP17i47u6N9M5Xh0"
      }
    ]
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/script.scriptapp",
    "https://www.googleapis.com/auth/script.external_request",
    "https://www.googleapis.com/auth/script.send_mail",
    "https://www.googleapis.com/auth/userinfo.email"
  ],
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8"
}

4 - setup the esports-notifier to run automatically every x minutes

Just follow what the bellow image shows, which is to select the setup function and run it.
After, a popup will appear asking your permission, and you'll have to accept it.

Uninstall

If you want to receive the daily emails, just go to the GAS respective project in the header dropbox 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.

🔧 Development

Development setup

Instructions for development setup

To setup this project in your computer, run the following commands:

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

# Go into the repository
$ cd esports-notifier

# Install dependencies
$ npm install

If you want to contribute to the project, fork the project, make the necessary changes, and to test your work you can load your version in apps scripts with almost no effort: replace the content of the getEsportsNotifier function with the following code:

function getEsportsNotifier() {
  // const version = "1.0.0" // version
  // const content = getEsportsProduction(version)
  const content = getEsportsDevelopment('yourgithub/project-fork', 'develop');
  eval(content);
  const esportsNotifier = new EsportsNotifier(CONFIGS);
  return esportsNotifier;
}

function getEsportsProduction(version) {
  return UrlFetchApp.fetch(`https://cdn.jsdelivr.net/npm/esports-notifier@${version}`).getContentText();
}

function getEsportsDevelopment(repository, branch) {
  const filePath = 'dist/EsportsNotifier.min.js';
  const final_link = `https://api.github.com/repos/${repository}/contents/${filePath}${branch ? `?ref=${branch}` : ''}`;
  const response = UrlFetchApp.fetch(final_link, { method: 'get', contentType: 'application/json' });
  const base64Content = JSON.parse(response.toString()).content;
  const decodedArr = Utilities.base64Decode(base64Content);
  const decodedAsString = Utilities.newBlob(decodedArr).getDataAsString();
  return decodedAsString;
}

This will allow you to esports-notifier source place (github repository or npm package) and specified version.

Used technologies

This project uses the following thechnologies:

Scope	Subject	Technologies
Main	Main
Setup	Code linting
	Commit linting
	Other

📚 About

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.