README.md

MMM-OlympicGames

Olympic Games Module for MagicMirror²

Example

Dependencies

• An installation of MagicMirror²
• npm
• node-fetch
• lodash

Installation

1. Clone this repo into ~/MagicMirror/modules directory.

2. Configure your ~/MagicMirror/config/config.js:

   {
       module: 'MMM-OlympicGames',
       position: 'top_right',
       config: {
           // all your config options, which are different than their default values
       }
   }
   

3. Run command npm install --production in ~/MagicMirror/modules/MMM-OlympicGames directory.

Global config

Option	Default	Description
locale	undefined	By default it is using your system settings. You can specify the locale in the global MagicMirror² config. Possible values are for e.g.: 'en-US' or 'de-DE'.

To set a global config you have to set the value in your config.js file inside the MagicMirror² project.

Config Options

Option	Default	Description
highlight	false	Which country (alpha-2 code) should be highlighted. E.g. 'DE' for Germany. You can find all alpha-2 codes here.
maxRows	10	How many countries should be displayed. Will be overwritten by config option countryList.
title	'Paris Summer Games 2024'	The title above the medal table.
reloadInterval	1800000 (30 mins)	How often should the data be fetched.
provider	'nbc'	Specify the data source. Possible options: 'nbc' and 'bloomberg'.
countryList	false	Specify a list of country codes to display (alpha-2 code), e.g. ['NO', 'AU', 'US', 'DE', 'FR', 'CA']. Config option maxRows will be automatically overwritten accordingly.

Developer

• npm run lint - Lints JS and CSS files.