Skip to content
Module for Magic Mirror that finds Happy Hours
JavaScript CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
img/readme added gif of module in readme Apr 9, 2018
translations init commit Mar 30, 2018
.gitignore parsed html to get happy hours and scrolls through them through the DOM Apr 8, 2018
.travis.yml added gif of module in readme Apr 9, 2018
MMM-HappyHours.css
MMM-HappyHours.js updated package.json Apr 9, 2018
README.md fixed link Apr 9, 2018
node_helper.js updated package.json Apr 9, 2018
package.json fixed version Apr 9, 2018

README.md

MMM-HappyHours

A module for the MagicMirror project by Michael Teeuw getting the happy hours that are in a certain location.

Maintainability Build Status

Gif

gif of module working
The module running in a corner

How it works

This module uses a happy hour finder website to find happy hours that are in your area. In your config.js, you are able to specify what city and state you would like to use. You can also specify if you would like to find happy hours for a specific day.

Installation

Installation is like most other Magic Mirror modules.

cd /MagicMirror/modules
git clone https://github.com/aleckeller/MMM-HappyHours.git
cd MMM-HappyHours
npm install

Configuration Options

Option Description
state

A string that specifies the state you would like to find the happy hours in.

Type: string OPTIONAL BUT ENCOURAGED
Example: us_ca
OPTIONS: us_al us_ak us_az us_ar us_ca us_co us_ct us_de us_fl us_ga us_hi us_id us_il us_in us_ia us_ks us_ky us_la us_me us_md us_ma us_mi us_mn us_ms us_mo us_mt us_ne us_nv us_nh us_nj us_nm us_ny us_nc us_nd us_oh us_ok us_or us_pa us_ri us_sc us_sd us_tn us_tx us_ut us_vt us_va us_wa us_dc us_wv us_wi us_wy
Default Value: us_va

city

A string that specifies the city you would like to find the happy hours in.

Type: string OPTIONAL BUT ENCOURAGED
Example: los-angeles
OPTIONS: If you are having trouble finding your city, go to http://thehappyhourfinder.com/, go to the bottom of the site, find your state, find your city in that state and click on the link, then look at the url and see what the correct value is for your city.
Default Value: richmond-6

useDayOfWeek

A boolean that specifies if you would like to only find the happy hours for the current day.

Type: boolean OPTIONAL
Example: false
Default Value: true

maxWidth

A string that specifies the width of the module.

Type: string OPTIONAL
Example: 325px
Default Value: 400px

maxHeight

A string that specifies the height of the module.

Type: string OPTIONAL
Example: 250px
Default Value: 200px

scrollSpeed

An integer that specifies how fast you would like the module to scroll through the happy hours. The larger the number, the slower it will scroll.

Type: integer OPTIONAL
Example: 80
Default Value: 100

You can’t perform that action at this time.