MMM-GitQuotes

A Module for MagicMirror designed to display the quotes from a json file on a github repository.

Sample

Module installation

Clone the repository into MagicMirror/modules directory

cd ~/MagicMirror/modules
git clone https://github.com/OscarVsp/MMM-GitQuotes.git

Install the dependencies

cd /MMM-GitQuotes
npm install

Configuration

Basic Example:

{
  module: 'MMM-GitQuotes',
  position: 'bottom_left',
  config: {
    github_raw_url: 'https://raw.githubusercontent.com/OscarVsp/MMM-GitQuotes/main/quotes.json'
},

Parameters

Option	Type	Description
`github_raw_url`	Required	The url of the json file on github (must be the raw url). Type: raw url Default: `https://raw.githubusercontent.com/OscarVsp/MMM-GitQuotes/main/quotes.json`
`updateInterval`	Optional	The interval of time for the update (in second). Type: int Default: `60` ==> 1 min.
`fadeSpeed`	Optional	The duration of the fade animation bewteen two quotes (in second). Type: int Default: `5` ==> 5 seconds.

Raw URL

The github_raw_url is not the same as the github url of the file. See on the image below how to get it. The repository must be public.

Attribution

Based on MagicMirror-QuotesCatalog from Salpar.

OscarVsp / MMM-GitQuotes