An open API service indexing awesome lists of open source software.

https://github.com/mumblebaj/mmm-wotd

Word of the Day Multiple Languages for MagicMirror²
https://github.com/mumblebaj/mmm-wotd

magicmirror2 wotd

Last synced: 2 months ago
JSON representation

Word of the Day Multiple Languages for MagicMirror²

Awesome Lists containing this project

README

          

# MMM-WOTD

Yet another Word of the Day module for [MagicMirror²](https://magicmirror.builders). Difference with this one is that you can select `Spanish` or `Portuguese` and some other lamguages. See config section for supported languages.

[![Platform](https://img.shields.io/badge/platform-MagicMirror-informational)](https://MagicMirror.builders)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE)

## Support
If you like my module you can support my work by giving me a star ir buy me a coffee.

Buy Me A Beer

## Spanish Example
![Example](image-1.png)

## Portuguese Example
![Example](image-2.png)

## German Example
![Example](image-3.png)

## Dependencies
- axios@0.27.2
- cheerio@1.0.0-rc.10

## Updates
### v1.1.0
- Source changed and as a result module had to change.
- Updated module to extract the information from new elements

### v1.0.3
- New URL for English Language.

## Installation

In your terminal, go to your MagicMirror's Module folder:
````
cd ~/MagicMirror/modules
````

Clone this repository:
````
git clone https://github.com/mumblebaj/MMM-WOTD.git
````
````
cd MMM-WOTD
npm install
````

Add the module to the modules array in the `config/config.js` file:
````javascript
{
module: 'MMM-WOTD',
position: 'middle_center',
config: {
updateInterval: 86400000,
retryDelay: 5000,
showExamples: true,
showExampleTranslations: true,
language: ["spanish", "german", "arabic", "dutch"]
}
},
````

## Configuration options

The following properties can be configured:

| Option | Description
| ---------------------------- | -----------
| `updateInterval` | As this is a "Word of the Day" it is recommended to set the value to 24hrs (86400000)
| `retryDelay` | How long to wait before retry
| `rotateInterval` | Interval at which to roate between languages when multiple languages have been selected
| `showExamples` | If you would like to see some example usages of the word set this to `true`. Default is `true`

**Possible values:** `true` or `false`
| `showExampleTranslations` | If you want the example with its English translation set this to `true`

**Possible values:** `true` or `false`,
| `language` | An Array of Languages. Which language WOTD would you like? Various Languages supported

**Possible values:** `afrikaans`, `arabic`, `bulgarian`, `dutch`, `english`, `filipino`, `finnish`, `french`, `german`, `greek`, `hebrew`, `hindi`, `hungarian`, `indonesian`, `italian`, `japanese`, `korean`, `norwegian`, `persian`, `polish`, `portuguese`, `romanian`, `russian`, `spanish`, `swahili`, `swedish`, `thai`, `turkish`, `urdu`, `vietnamese`

## Updating

To update the module to the latest version, use your terminal to go to your MMM-WOTD module folder and type the following command:

````
cd MMM-WOTD
git pull
npm install
````