https://github.com/leabs/mmm-urbandictionary

MagicMirror Module displaying random words from urbandictionary's API.
https://github.com/leabs/mmm-urbandictionary

magicmirror magicmirror-module

Last synced: about 1 month ago
JSON representation

MagicMirror Module displaying random words from urbandictionary's API.

• Host: GitHub
• URL: https://github.com/leabs/mmm-urbandictionary
• Owner: leabs
• License: mit
• Created: 2023-01-21T16:35:20.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-26T15:59:01.000Z (almost 2 years ago)
• Last Synced: 2024-11-29T06:41:02.276Z (about 1 month ago)
• Topics: magicmirror, magicmirror-module
• Language: JavaScript
• Homepage:
• Size: 464 KB
• Stars: 5
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MMM-urbandictionary

A [MagicMirror](https://github.com/MichMich/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](/screenshot/mirror.png)

## Requirements

This module is to be used with the [MagicMirror](https://github.com/MichMich/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](https://www.reddit.com/r/MagicMirror/) and also the [MagicMirror Forums](https://forum.magicmirror.builders/) if you need help with getting started. There is also great [documentation](https://magicmirror.builders/) 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.