leabs / MMM-urbandictionary

MagicMirror Module displaying random words from urbandictionary's API.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MMM-urbandictionary

A MagicMirror Module to show random words from urbandictionary.com. This shows the word, definition, example, and author and updates every 3 minutes.

MMM-urbandictionary module screenshot

Requirements

This module is to be used with the MagicMirror project, so it assumes you have a working MagicMirror set up and running already. There is a great community for this project on places like Reddit and also the MagicMirror Forums if you need help with getting started. There is also great documentation if you'd like to get started building your own module.

Installation

  1. Navigate into your MagicMirror's modules folder and execute git clone https://github.com/leabs/MMM-urbandictionary.git
  2. Open your config file in config/config.js and add the module to the modules array like so:
modules: [
    ...Other Modules Here...,
    {
        module: 'MMM-urbandictionary',
        position: 'top_right',
    }
]

Note: The custom CSS for this module (style.css) is located in the MMM-urbandictionary folder and is set for a width of 420px. This value may have to be adjusted for your mirror and preferred location for the module.

About

MagicMirror Module displaying random words from urbandictionary's API.

License:MIT License


Languages

Language:JavaScript 91.1%Language:CSS 8.9%