Merge pull request #1776 from MichMich/develop

v2.9.0

.eslintignore

@@ -1,7 +1,5 @@
-vendor/
+vendor/*
 !/vendor/vendor.js
-/modules/**
 !/modules/default/**
 !/modules/node_helper
 !/modules/node_helper/**
-!/modules/default/defaultmodules.js

.eslintrc.json

@@ -2,13 +2,24 @@
 	"rules": {
 		"indent": ["error", "tab"],
 		"quotes": ["error", "double"],
+        "semi": ["error"],
 		"max-len": ["error", 250],
 		"curly": "error",
-		"camelcase": ["error", {"properties": "never"}]
+		"camelcase": ["error", {"properties": "never"}],
+        "no-multiple-empty-lines": ["error", { "max": 1, "maxEOF": 1 }],
+		"no-trailing-spaces": ["error", {"ignoreComments": false }],
+		"no-irregular-whitespace": ["error"]
 	},
 	"env": {
 		"browser": true,
 		"node": true,
 		"es6": true
-	}
-}
+	},
+	"parserOptions": {
+		"sourceType": "module",
+		"ecmaVersion": 2017,
+		"ecmaFeatures": {
+			"globalReturn": true
+		}
+    }
+}

.github/CONTRIBUTING.md

@@ -3,57 +3,47 @@ Contribution Policy for MagicMirror²
 
 Thanks for contributing to MagicMirror²!
 
-We hold our code to standard, and these standards are documented below. 
+We hold our code to standard, and these standards are documented below.
 
-First, before you run the linters, you will need to install them all **and** install the development dependencies:
+If you wish to run both linters, use `grunt` without any arguments.
 
-```bash
-(sudo) npm install -g jscs stylelint html-validator-cli
-npm install
-```
+### JavaScript: Run ESLint
 
-### JavaScript: Run JSCS
+We use [ESLint](http://eslint.org) on our JavaScript files.
 
-We use [JSCS](http://jscs.info) on our JavaScript files.
+Our ESLint configuration is in our .eslintrc.json and .eslintignore files.
 
-Our JSCS configuration is in our .jscsrc file.
-
-To run JSCS, use `npm run jscs`.
+To run ESLint, use `grunt eslint`.
 
 ### CSS: Run StyleLint
 
 We use [StyleLint](http://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
 
-To run StyleLint, use `npm run stylelint`.
+To run StyleLint, use `grunt stylelint`.
 
-### HTML: Run HTML Validator
+### Submitting Issues
 
-We use [NU Validator](https://validator.w3.org/nu) to validate our HTML. The configuration is in the command in the package.json file.
+Please only submit reproducible issues.
 
-To run HTML Validator, use `npm run htmlvalidator`.
-
-## Submitting Issues
-
-Please only submit reproducible issues. 
-
-If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: https://forum.magicmirror.builders/category/15/bug-hunt - Problems installing or configuring your MagicMirror? Check out: https://forum.magicmirror.builders/category/10/troubleshooting
+If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
+Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
 
 When submitting a new issue, please supply the following information:
 
-**Platform** [ Raspberry Pi 2/3, Windows, Mac OS X, Linux, Etc ... ]:
+**Platform**: Place your platform here... give us your web browser/Electron version *and* your hardware (Raspberry Pi 2/3, Windows, Mac, Linux, System V UNIX).
 
-**Node Version** [ 0.12.13 or later ]:
+**Node Version**: Make sure it's version 0.12.13 or later.
 
-**MagicMirror Version** [ V1 / V2-Beta ]:
+**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
 
-**Description:** Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
+**Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
 
-**Steps to Reproduce:** List the step by step process to reproduce the issue.
+**Steps to Reproduce**: List the step by step process to reproduce the issue.
 
-**Expected Results:** Describe what you expected to see.
+**Expected Results**: Describe what you expected to see.
 
-**Actual Results:** Describe what you actually saw.
+**Actual Results**: Describe what you actually saw.
 
-**Configuration:** What does the used config.js file look like? (Don't forget to remove any sensitive information.)
+**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!
 
-**Additional Notes:** Provide any other relevant notes not previously mentioned (optional)
+**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

.github/ISSUE_TEMPLATE.md

@@ -1,21 +1,24 @@
 Please only submit reproducible issues. 
 
-If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: https://forum.magicmirror.builders/category/15/bug-hunt - Problems installing or configuring your MagicMirror? Check out: https://forum.magicmirror.builders/category/10/troubleshooting
+If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
+Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
 
-**Platform** [ Raspberry Pi 2/3, Windows, Mac OS X, Linux, Etc ... ]:
+When submitting a new issue, please supply the following information:
 
-**Node Version** [ 0.12.13 or later ]:
+**Platform**: Place your platform here... give us your web browser/Electron version *and* your hardware (Raspberry Pi 2/3, Windows, Mac, Linux, System V UNIX).
 
-**MagicMirror Version** [ V1 / V2-Beta ]:
+**Node Version**: Make sure it's version 0.12.13 or later.
 
-**Description:** Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
+**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
 
-**Steps to Reproduce:** List the step by step process to reproduce the issue.
+**Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
 
-**Expected Results:** Describe what you expected to see.
+**Steps to Reproduce**: List the step by step process to reproduce the issue.
 
-**Actual Results:** Describe what you actually saw.
+**Expected Results**: Describe what you expected to see.
 
-**Configuration:** What does the used config.js file look like? (Don't forget to remove any sensitive information.)
+**Actual Results**: Describe what you actually saw.
 
-**Additional Notes:** Provide any other relevant notes not previously mentioned (optional)
+**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!
+
+**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,14 @@
-> Please send your PR's the develop branch. 
-> Don't forget to add the change to changelog.md.
+> Please send your pull requests the develop branch.
+> Don't forget to add the change to CHANGELOG.md.
 
-* Does the pull request solve a **related** issue? [yes | no]
+**Note**: Sometimes the development moves very fast. It is highly
+recommended that you update your branch of `develop` before creating a
+pull request to send us your changes. This makes everyone's lives
+easier (including yours) and helps us out on the development team.
+Thanks!
+
+
+* Does the pull request solve a **related** issue?
 * If so, can you reference the issue?
-* What does the pull request accomplish? (please list)
+* What does the pull request accomplish? Use a list if needed.
 * If it includes major visual changes please add screenshots.
-
-

.github/stale.yml

@@ -0,0 +1,19 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+  - under investigation
+  - pr welcome
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.gitignore

@@ -11,11 +11,19 @@ coverage
 .grunt
 .lock-wscript
 build/Release
-node_modules
+/node_modules/**/*
+fonts/node_modules/**/*
+vendor/node_modules/**/*
 jspm_modules
 .npm
 .node_repl_history
 
+# Visual Studio Code ignoramuses.
+.vscode/
+
+# IDE Code ignoramuses.
+.idea/
+
 # Various Windows ignoramuses.
 Thumbs.db
 ehthumbs.db
@@ -53,14 +61,27 @@ Temporary Items
 
 # Various Magic Mirror ignoramuses and anti-ignoramuses.
 
-# Don't ignore the node_helper nore module.
+# Don't ignore the node_helper core module.
 !/modules/node_helper
 !/modules/node_helper/**
 
 # Ignore all modules except the default modules.
 /modules/**
+!/modules/default
 !/modules/default/**
 !/modules/README.md**
 
 # Ignore changes to the custom css files.
 /css/custom.css
+
+# Vim
+## swap
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+
+## diff patch
+*.orig
+*.rej
+*.bak
+
+!/tests/node_modules/**/*

.stylelintrc

@@ -1,4 +0,0 @@
-{
-	"extends": "stylelint-config-standard",
-	"font-family-name-quotes": "double-where-recommended"
-}

.stylelintrc.json

@@ -0,0 +1,5 @@
+{
+	"extends": "stylelint-config-standard",
+	"font-family-name-quotes": "double-where-recommended",
+	"block-no-empty": false
+}

.travis.yml

@@ -1,7 +1,19 @@
+dist: trusty
 language: node_js
 node_js:
- - "6"
- - "5.1"
+ - "8"
 before_script:
+ - yarn danger ci
  - npm install grunt-cli -g
-script: grunt
+ - "export DISPLAY=:99.0"
+ - "sh -e /etc/init.d/xvfb start"
+ - sleep 5
+script:
+- grunt
+- npm run test:unit
+- npm run test:e2e
+after_script:
+ - npm list
+cache:
+ directories:
+  - node_modules

CHANGELOG.md

@@ -1,20 +1,572 @@
 # MagicMirror² Change Log
+
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+---
+
+❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror² core.
+
+## [2.9.0] - 2019-10-01
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`. If you are having issues running Electron, make sure your [Raspbian is up to date](https://www.raspberrypi.org/documentation/raspbian/updating.md).
+
+### Added
+- Spanish translation for "PRECIP".
+- Adding a Malay (Malaysian) translation for MagicMirror².
+- Add test check URLs of vendors 200 and 404 HTTP CODE.
+- Add tests for new weather module and helper to stub ajax requests.
+
+### Updated
+- Updatenotification module: Display update notification for a limited (configurable) time.
+- Enabled e2e/vendor_spec.js tests.
+- The css/custom.css will be rename after the next release. We've add into `run-start.sh` a instruction by GIT to ignore with `--skip-worktree` and `rm --cached`. [#1540](https://github.com/MichMich/MagicMirror/issues/1540)
+- Disable sending of notification CLOCK_SECOND when displaySeconds is false.
+
+### Fixed
+- Updatenotification module: Properly handle race conditions, prevent crash.
+- Send `NEWS_FEED` notification also for the first news messages which are shown.
+- Fixed issue where weather module would not refresh data after a network or API outage. [#1722](https://github.com/MichMich/MagicMirror/issues/1722)
+- Fixed weatherforecast module not displaying rain amount on fallback endpoint.
+- Notifications CLOCK_SECOND & CLOCK_MINUTE being from startup instead of matched against the clock and avoid drifting.
+
+## [2.8.0] - 2019-07-01
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`. If you are having issues running Electron, make sure your [Raspbian is up to date](https://www.raspberrypi.org/documentation/raspbian/updating.md).
+
+### Added
+- Option to show event location in calendar
+- Finnish translation for "Feels" and "Weeks"
+- Russian translation for “Feels”
+- Calendar module: added `nextDaysRelative` config option
+- Add `broadcastPastEvents` config option for calendars to include events from the past `maximumNumberOfDays` in event broadcasts
+- Added feature to broadcast news feed items `NEWS_FEED` and updated news items `NEWS_FEED_UPDATED` in default [newsfeed](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/newsfeed) module (when news is updated) with documented default and `config.js` options in [README.md](https://github.com/MichMich/MagicMirror/blob/develop/modules/default/newsfeed/README.md)
+- Added notifications to default `clock` module broadcasting `CLOCK_SECOND` and `CLOCK_MINUTE` for the respective time elapsed.
+- Added UK Met Office Datapoint feed as a provider in the default weather module.
+- Added new provider class
+- Added suncalc.js dependency to calculate sun times (not provided in UK Met Office feed)
+- Added "tempUnits" and "windUnits" to allow, for example, temp in metric (i.e. celsius) and wind in imperial (i.e. mph). These will override "units" if specified, otherwise the "units" value will be used.
+- Use Feels Like temp from feed if present
+- Optionally display probability of precipitation (PoP) in current weather (UK Met Office data)
+- Automatically try to fix eslint errors by passing `--fix` option to it
+- Added sunrise and sunset times to weathergov weather provider [#1705](https://github.com/MichMich/MagicMirror/issues/1705)
+- Added "useLocationAsHeader" to display "location" in `config.js` as header when location name is not returned
+- Added to `newsfeed.js`: in order to design the news article better with css, three more class-names were introduced: newsfeed-desc, newsfeed-desc, newsfeed-desc
+
+### Updated
+- English translation for "Feels" to "Feels like"
+- Fixed the example calender url in `config.js.sample`
+- Update `ical.js` to solve various calendar issues.
+- Update weather city list url [#1676](https://github.com/MichMich/MagicMirror/issues/1676)
+- Only update clock once per minute when seconds aren't shown
+
+### Fixed
+- Fixed uncaught exception, race condition on module update
+- Fixed issue [#1696](https://github.com/MichMich/MagicMirror/issues/1696), some ical files start date to not parse to date type
+- Allowance HTML5 autoplay-policy (policy is changed from Chrome 66 updates)
+- Handle SIGTERM messages
+- Fixes sliceMultiDayEvents so it respects maximumNumberOfDays
+- Minor types in default NewsFeed [README.md](https://github.com/MichMich/MagicMirror/blob/develop/modules/default/newsfeed/README.md)
+- Fix typos and small syntax errors, cleanup dependencies, remove multiple-empty-lines, add semi-rule
+- Fixed issues with calendar not displaying one-time changes to repeating events
+- Updated the fetchedLocationName variable in currentweather.js so that city shows up in the header
+
+### Updated installer
+- give non-pi2+ users (pi0, odroid, jetson nano, mac, windows, ...) option to continue install
+- use current username vs hardcoded 'pi' to support non-pi install
+- check for npm installed. node install doesn't do npm anymore
+- check for mac as part of PM2 install, add install option string
+- update pm2 config with current username instead of hard coded 'pi'
+- check for screen saver config, "/etc/xdg/lxsession", bypass if not setup
+
+## [2.7.1] - 2019-04-02
+
+Fixed `package.json` version number.
+
+## [2.7.0] - 2019-04-01
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`. If you are having issues running Electron, make sure your [Raspbian is up to date](https://www.raspberrypi.org/documentation/raspbian/updating.md).
+
+### Added
+- Italian translation for "Feels"
+- Basic Klingon (tlhIngan Hol) translations
+- Disabled the screensaver on raspbian with installation script
+- Added option to truncate the number of vertical lines a calendar item can span if `wrapEvents` is enabled.
+- Danish translation for "Feels" and "Weeks"
+- Added option to split multiple day events in calendar to separate numbered events
+- Slovakian translation
+- Alerts now can contain Font Awesome icons
+- Notifications display time can be set in request
+- Newsfeed: added support for `ARTICLE_INFO_REQUEST` notification
+- Add `name` config option for calendars to be sent along with event broadcasts
+
+### Updated
+- Bumped the Electron dependency to v3.0.13 to support the most recent Raspbian. [#1500](https://github.com/MichMich/MagicMirror/issues/1500)
+- Updated modernizr code in alert module, fixed a small typo there too
+- More verbose error message on console if the config is malformed
+- Updated installer script to install Node.js version 10.x
+
+### Fixed
+- Fixed temperature displays in currentweather and weatherforecast modules [#1503](https://github.com/MichMich/MagicMirror/issues/1503), [#1511](https://github.com/MichMich/MagicMirror/issues/1511).
+- Fixed unhandled error on bad git data in updatenotification module [#1285](https://github.com/MichMich/MagicMirror/issues/1285).
+- Weather forecast now works with openweathermap in new weather module. Daily data are displayed, see issue [#1504](https://github.com/MichMich/MagicMirror/issues/1504).
+- Fixed analogue clock border display issue where non-black backgrounds used (previous fix for issue 611)
+- Fixed compatibility issues caused when modules request different versions of Font Awesome, see issue [#1522](https://github.com/MichMich/MagicMirror/issues/1522). MagicMirror now uses [Font Awesome 5 with v4 shims included for backwards compatibility](https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4#shims).
+- Installation script problems with raspbian
+- Calendar: only show repeating count if the event is actually repeating [#1534](https://github.com/MichMich/MagicMirror/pull/1534)
+- Calendar: Fix exdate handling when multiple values are specified (comma separated)
+- Calendar: Fix relative date handling for fulldate events, calculate difference always from start of day  [#1572](https://github.com/MichMich/MagicMirror/issues/1572)
+- Fix null dereference in moduleNeedsUpdate when the module isn't visible
+- Calendar: Fixed event end times by setting default calendarEndTime to "LT" (Local time format). [#1479]
+- Calendar: Fixed missing calendar fetchers after server process restarts [#1589](https://github.com/MichMich/MagicMirror/issues/1589)
+- Notification: fixed background color (was white text on white background)
+- Use getHeader instead of data.header when creating the DOM so overwriting the function also propagates into it
+- Fix documentation of `useKMPHwind` option in currentweather
+
+### New weather module
+- Fixed weather forecast table display [#1499](https://github.com/MichMich/MagicMirror/issues/1499).
+- Dimmed loading indicator for weather forecast.
+- Implemented config option `decimalSymbol` [#1499](https://github.com/MichMich/MagicMirror/issues/1499).
+- Aligned indoor values in current weather vertical [#1499](https://github.com/MichMich/MagicMirror/issues/1499).
+- Added humidity support to nunjuck unit filter.
+- Do not display degree symbol for temperature in Kelvin [#1503](https://github.com/MichMich/MagicMirror/issues/1503).
+- Weather forecast now works with openweathermap for both, `/forecast` and `/forecast/daily`, in new weather module. If you use the `/forecast`-weatherEndpoint, the hourly data are converted to daily data, see issues [#1504](https://github.com/MichMich/MagicMirror/issues/1504), [#1513](https://github.com/MichMich/MagicMirror/issues/1513).
+- Added fade, fadePoint and maxNumberOfDays properties to the forecast mode [#1516](https://github.com/MichMich/MagicMirror/issues/1516)
+- Fixed Loading string and decimalSymbol string replace [#1538](https://github.com/MichMich/MagicMirror/issues/1538)
+- Show Snow amounts in new weather module [#1545](https://github.com/MichMich/MagicMirror/issues/1545)
+- Added weather.gov as a new weather provider for US locations
+
+## [2.6.0] - 2019-01-01
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`. If you are having issues updating, make sure you are running the latest version of Node.
+
+### ✨ Experimental ✨
+- New default [module weather](modules/default/weather). This module will eventually replace the current `currentweather` and `weatherforecast` modules. The new module is still pretty experimental, but it's included so you can give it a try and help us improve this module. Please give us you feedback using [this forum post](https://forum.magicmirror.builders/topic/9335/default-weather-module-refactoring).
+
+A huge, huge, huge thanks to user @fewieden for all his hard work on the new `weather` module!
+
+### Added
+- Possibility to add classes to the cell of symbol, title and time of the events of calendar.
+- Font-awesome 5, still has 4 for backwards compatibility.
+- Missing `showEnd` in calendar documentation
+- Screenshot for the new feed module
+- Screenshot for the compliments module
+- Screenshot for the clock module
+- Screenshot for the current weather
+- Screenshot for the weather forecast module
+- Portuguese translation for "Feels"
+- Croatian translation
+- Fading for dateheaders timeFormat in Calendar [#1464](https://github.com/MichMich/MagicMirror/issues/1464)
+- Documentation for the existing `scale` option in the Weather Forecast module.
+
+### Fixed
+- Allow to parse recurring calendar events where the start date is before 1900
+- Fixed Polish translation for Single Update Info
+- Ignore entries with unparseable details in the calendar module
+- Bug showing FullDayEvents one day too long in calendar fixed
+- Bug in newsfeed when `removeStartTags` is used on the description [#1478](https://github.com/MichMich/MagicMirror/issues/1478)
+
+### Updated
+- The default calendar setting `showEnd` is changed to `false`.
+
+### Changed
+- The Weather Forecast module by default displays the ° symbol after every numeric value to be consistent with the Current Weather module.
+
+
+## [2.5.0] - 2018-10-01
+
+### Added
+- Romanian translation for "Feels"
+- Support multi-line compliments
+- Simplified Chinese translation for "Feels"
+- Polish translate for "Feels"
+- French translate for "Feels"
+- Translations for newsfeed module
+- Support for toggling news article in fullscreen
+- Hungarian translation for "Feels" and "Week"
+- Spanish translation for "Feels"
+- Add classes instead of inline style to the message from the module Alert
+- Support for events having a duration instead of an end
+- Support for showing end of events through config parameters showEnd and dateEndFormat
+
+### Fixed
+- Fixed gzip encoded calendar loading issue #1400.
+- Mixup between german and spanish translation for newsfeed.
+- Fixed close dates to be absolute, if no configured in the config.js - module Calendar
+- Fixed the updatenotification module message about new commits in the repository, so they can be correctly localized in singular and plural form.
+- Fix for weatherforecast rainfall rounding [#1374](https://github.com/MichMich/MagicMirror/issues/1374)
+- Fix calendar parsing issue for Midori on RasperryPi Zero w, related to issue #694.
+- Fix weather city ID link in sample config
+- Fixed issue with clientonly not updating with IP address and port provided on command line.
+
+### Updated
+
+- Updated Simplified Chinese translation
+- Swedish translations
+- Hungarian translations for the updatenotification module
+- Updated Norsk bokmål translation
+- Updated Norsk nynorsk translation
+- Consider multi days event as full day events
+
+## [2.4.1] - 2018-07-04
+
+### Fixed
+
+- Fix weather parsing issue #1332.
+
+## [2.4.0] - 2018-07-01
+
+⚠️ **Warning:** This release includes an updated version of Electron. This requires a Raspberry Pi configuration change to allow the best performance and prevent the CPU from overheating. Please read the information on the [MagicMirror Wiki](https://github.com/michmich/magicmirror/wiki/configuring-the-raspberry-pi#enable-the-open-gl-driver-to-decrease-electrons-cpu-usage).
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Added
+
+- Enabled translation of feelsLike for module currentweather
+- Added support for on-going calendar events
+- Added scroll up in fullscreen newsfeed article view
+- Changed fullscreen newsfeed width from 100% to 100vw (better results)
+- Added option to calendar module that colors only the symbol instead of the whole line
+- Added option for new display format in the calendar module with date headers with times/events below.
+- Ability to fetch compliments from a remote server
+- Add regex filtering to calendar module
+- Customize classes for table
+- Added option to newsfeed module to only log error parsing a news article if enabled
+- Add update translations for Português Brasileiro
+
+### Changed
+- Upgrade to Electron 2.0.0.
+- Remove yarn-or-npm which breaks production builds.
+- Invoke module suspend even if no dom content. [#1308](https://github.com/MichMich/MagicMirror/issues/1308)
+
+### Fixed
+- Fixed issue where wind chill could not be displayed in Fahrenheit. [#1247](https://github.com/MichMich/MagicMirror/issues/1247)
+- Fixed issues where a module crashes when it tries to dismiss a non existing alert. [#1240](https://github.com/MichMich/MagicMirror/issues/1240)
+- In default module currentWeather/currentWeather.js line 296, 300, self.config.animationSpeed can not be found because the notificationReceived function does not have "self" variable.
+- Fixed browser-side code to work on the Midori browser.
+- Fixed issue where heat index was reporting incorrect values in Celsius and Fahrenheit. [#1263](https://github.com/MichMich/MagicMirror/issues/1263)
+- Fixed weatherforecast to use dt_txt field instead of dt to handle timezones better
+- Newsfeed now remembers to show the description when `"ARTICLE_LESS_DETAILS"` is called if the user wants to always show the description. [#1282](https://github.com/MichMich/MagicMirror/issues/1282)
+- `clientonly/*.js` is now linted, and one linting error is fixed
+- Fix issue #1196 by changing underscore to hyphen in locale id, in align with momentjs.
+- Fixed issue where heat index and wind chill were reporting incorrect values in Kelvin. [#1263](https://github.com/MichMich/MagicMirror/issues/1263)
+
+### Updated
+- Updated Italian translation
+- Updated German translation
+- Updated Dutch translation
+
+## [2.3.1] - 2018-04-01
+
+### Fixed
+- Downgrade electron to 1.4.15 to solve the black screen issue.[#1243](https://github.com/MichMich/MagicMirror/issues/1243)
+
+## [2.3.0] - 2018-04-01
+
+### Added
+
+- Add new settings in compliments module: setting time intervals for morning and afternoon
+- Add system notification `MODULE_DOM_CREATED` for notifying each module when their Dom has been fully loaded.
+- Add types for module.
+- Implement Danger.js to notify contributors when CHANGELOG.md is missing in PR.
+- Allow to scroll in full page article view of default newsfeed module with gesture events from [MMM-Gestures](https://github.com/thobach/MMM-Gestures)
+- Changed 'compliments.js' - update DOM if remote compliments are loaded instead of waiting one updateInterval to show custom compliments
+- Automated unit tests utils, deprecated, translator, cloneObject(lockstrings)
+- Automated integration tests translations
+- Add advanced filtering to the excludedEvents configuration of the default calendar module
+- New currentweather module config option: `showFeelsLike`: Shows how it actually feels like. (wind chill or heat index)
+- New currentweather module config option: `useKMPHwind`: adds an option to see wind speed in Kmph instead of just m/s or Beaufort.
+- Add dc:date to parsing in newsfeed module, which allows parsing of more rss feeds.
+
+### Changed
+- Add link to GitHub repository which contains the respective Dockerfile.
+- Optimized automated unit tests cloneObject, cmpVersions
+- Update notifications use now translation templates instead of normal strings.
+- Yarn can be used now as an installation tool
+- Changed Electron dependency to v1.7.13.
+
+### Fixed
+- News article in fullscreen (iframe) is now shown in front of modules.
+- Forecast respects maxNumberOfDays regardless of endpoint.
+- Fix exception on translation of objects.
+
+## [2.2.2] - 2018-01-02
+
+### Added
+
+- Add missing `package-lock.json`.
+
+### Changed
+
+- Changed Electron dependency to v1.7.10.
+
+## [2.2.1] - 2018-01-01
+
+### Fixed
+- Fixed linting errors.
+
+## [2.2.0] - 2018-01-01
+
+**Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Changed
+- Calender week is now handled with a variable translation in order to move number language specific.
+- Reverted the Electron dependency back to 1.4.15 since newer version don't seem to work on the Raspberry Pi very well.
+
+### Added
+- Add option to use [Nunjucks](https://mozilla.github.io/nunjucks/) templates in modules. (See `helloworld` module as an example.)
+- Add Bulgarian translations for MagicMirror² and Alert module.
+- Add graceful shutdown of modules by calling `stop` function of each `node_helper` on SIGINT before exiting.
+- Link update subtext to Github diff of current version versus tracking branch.
+- Add Catalan translation.
+- Add ability to filter out newsfeed items based on prohibited words found in title (resolves #1071)
+- Add options to truncate description support of a feed in newsfeed module
+- Add reloadInterval option for particular feed in newsfeed module
+- Add no-cache entries of HTTP headers in newsfeed module (fetcher)
+- Add Czech translation.
+- Add option for decimal symbols other than the decimal point for temperature values in both default weather modules: WeatherForecast and CurrentWeather.
+
+### Fixed
+- Fixed issue with calendar module showing more than `maximumEntries` allows
+- WeatherForecast and CurrentWeather are now using HTTPS instead of HTTP
+- Correcting translation for Indonesian language
+- Fix issue where calendar icons wouldn't align correctly
+
+## [2.1.3] - 2017-10-01
+
+**Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Changed
+- Remove Roboto fonts files inside `fonts` and these are installed by npm install command.
+
+### Added
+- Add `clientonly` script to start only the electron client for a remote server.
+- Add symbol and color properties of event when `CALENDAR_EVENTS` notification is broadcasted from `default/calendar` module.
+- Add `.vscode/` folder to `.gitignore` to keep custom Visual Studio Code config out of git.
+- Add unit test the capitalizeFirstLetter function of newsfeed module.
+- Add new unit tests for function `shorten` in calendar module.
+- Add new unit tests for function `getLocaleSpecification` in calendar module.
+- Add unit test for js/class.js.
+- Add unit tests for function `roundValue` in currentweather module.
+- Add test e2e showWeek feature in spanish language.
+- Add warning Log when is used old authentication method in the calendar module.
+- Add test e2e for helloworld module with default config text.
+- Add ability for `currentweather` module to display indoor humidity via INDOOR_HUMIDITY notification.
+- Add Welsh (Cymraeg) translation.
+- Add Slack badge to Readme.
+
+### Updated
+- Changed 'default.js' - listen on all attached interfaces by default.
+- Add execution of `npm list` after the test are ran in Travis CI.
+- Change hooks for the vendors e2e tests.
+- Add log when clientonly failed on starting.
+- Add warning color when are using full ip whitelist.
+- Set version of the `express-ipfilter` on 0.3.1.
+
+### Fixed
+- Fixed issue with incorrect alignment of analog clock when displayed in the center column of the MM.
+- Fixed ipWhitelist behaviour to make empty whitelist ([]) allow any and all hosts access to the MM.
+- Fixed issue with calendar module where 'excludedEvents' count towards 'maximumEntries'.
+- Fixed issue with calendar module where global configuration of maximumEntries was not overridden by calendar specific config (see module doc).
+- Fixed issue where `this.file(filename)` returns a path with two hashes.
+- Workaround for the WeatherForecast API limitation.
+
+## [2.1.2] - 2017-07-01
+
+### Changed
+- Revert Docker related changes in favor of [docker-MagicMirror](https://github.com/bastilimbach/docker-MagicMirror). All Docker images are outsourced. ([#856](https://github.com/MichMich/MagicMirror/pull/856))
+- Change Docker base image (Debian + Node) to an arm based distro (AlpineARM + Node) ([#846](https://github.com/MichMich/MagicMirror/pull/846))
+- Fix the dockerfile to have it running from the first time.
+
+### Added
+- Add in option to wrap long calendar events to multiple lines using `wrapEvents` configuration option.
+- Add test e2e `show title newsfeed` for newsfeed module.
+- Add task to check configuration file.
+- Add test check URLs of vendors.
+- Add test of match current week number on clock module with showWeek configuration.
+- Add test default modules present modules/default/defaultmodules.js.
+- Add unit test calendar_modules function capFirst.
+- Add test for check if exists the directories present in defaults modules.
+- Add support for showing wind direction as an arrow instead of abbreviation in currentWeather module.
+- Add support for writing translation functions to support flexible word order
+- Add test for check if exits the directories present in defaults modules.
+- Add calendar option to set a separate date format for full day events.
+- Add ability for `currentweather` module to display indoor temperature via INDOOR_TEMPERATURE notification
+- Add ability to change the path of the `custom.css`.
+- Add translation Dutch to Alert module.
+- Added Romanian translation.
+
+### Updated
+- Added missing keys to Polish translation.
+- Added missing key to German translation.
+- Added better translation with flexible word order to Finnish translation.
+
+### Fixed
+- Fix instruction in README for using automatically installer script.
+- Bug of duplicated compliments as described in [here](https://forum.magicmirror.builders/topic/2381/compliments-module-stops-cycling-compliments).
+- Fix double message about port when server is starting
+- Corrected Swedish translations for TODAY/TOMORROW/DAYAFTERTOMORROW.
+- Removed unused import from js/electron.js
+- Made calendar.js respect config.timeFormat irrespective of locale setting.
+- Fixed alignment of analog clock when a large calendar is displayed in the same side bar.
+
+## [2.1.1] - 2017-04-01
+
+**Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Changed
+- Add `anytime` group for Compliments module.
+- Compliments module can use remoteFile without default daytime arrays defined.
+- Installer: Use init config.js from config.js.sample.
+- Switched out `rrule` package for `rrule-alt` and fixes in `ical.js` in order to fix calendar issues. ([#565](https://github.com/MichMich/MagicMirror/issues/565))
+- Make mouse events pass through the region fullscreen_above to modules below.
+- Scaled the splash screen down to make it a bit more subtle.
+- Replace HTML tables with markdown tables in README files.
+- Added `DAYAFTERTOMORROW`, `UPDATE_NOTIFICATION` and `UPDATE_NOTIFICATION_MODULE` to Finnish translations.
+- Run `npm test` on Travis automatically.
+- Show the splash screen image even when is reboot or halted.
+- Added some missing translation strings in the sv.json file.
+- Run task jsonlint to check translation files.
+- Restructured Test Suite.
+
+### Added
+- Added Docker support (Pull Request [#673](https://github.com/MichMich/MagicMirror/pull/673)).
+- Calendar-specific support for `maximumEntries`, and ` maximumNumberOfDays`.
+- Add loaded function to modules, providing an async callback.
+- Made default newsfeed module aware of gesture events from [MMM-Gestures](https://github.com/thobach/MMM-Gestures)
+- Add use pm2 for manager process into Installer RaspberryPi script.
+- Russian Translation.
+- Afrikaans Translation.
+- Add postinstall script to notify user that MagicMirror installed successfully despite warnings from NPM.
+- Init tests using mocha.
+- Option to use RegExp in Calendar's titleReplace.
+- Hungarian Translation.
+- Icelandic Translation.
+- Add use a script to prevent when is run by SSH session set DISPLAY environment.
+- Enable ability to set configuration file by the environment variable called MM_CONFIG_FILE.
+- Option to give each calendar a different color.
+- Option for colored min-temp and max-temp.
+- Add test e2e helloworld.
+- Add test e2e environment.
+- Add `chai-as-promised` npm module to devDependencies.
+- Basic set of tests for clock module.
+- Run e2e test in Travis.
+- Estonian Translation.
+- Add test for compliments module for parts of day.
+- Korean Translation.
+- Added console warning on startup when deprecated config options are used.
+- Add option to display temperature unit label to the current weather module.
+- Added ability to disable wrapping of news items.
+- Added in the ability to hide events in the calendar module based on simple string filters.
+- Updated Norwegian translation.
+- Added hideLoading option for News Feed module.
+- Added configurable dateFormat to clock module.
+- Added multiple calendar icon support.
+- Added tests for Translations, dev argument, version, dev console.
+- Added test anytime feature compliments module.
+- Added test ipwhitelist configuration directive.
+- Added test for calendar module: default, basic-auth, backward compatibility, fail-basic-auth.
+- Added meta tags to support fullscreen mode on iOS (for server mode)
+- Added `ignoreOldItems` and `ignoreOlderThan` options to the News Feed module
+- Added test for MM_PORT environment variable.
+- Added a configurable Week section to the clock module.
+
+### Fixed
+- Update .gitignore to not ignore default modules folder.
+- Remove white flash on boot up.
+- Added `update` in Raspberry Pi installation script.
+- Fix an issue where the analog clock looked scrambled. ([#611](https://github.com/MichMich/MagicMirror/issues/611))
+- If units is set to imperial, the showRainAmount option of weatherforecast will show the correct unit.
+- Module currentWeather: check if temperature received from api is defined.
+- Fix an issue with module hidden status changing to `true` although lock string prevented showing it.
+- Fix newsfeed module bug (removeStartTags)
+- Fix when is set MM_PORT environment variable.
+- Fixed missing animation on `this.show(speed)` when module is alone in a region.
+
+## [2.1.0] - 2016-12-31
+
+**Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Added
+- Finnish translation.
+- Danish translation.
+- Turkish translation.
+- Option to limit access to certain IP addresses based on the value of `ipWhitelist` in the `config.js`, default is access from localhost only (Issue [#456](https://github.com/MichMich/MagicMirror/issues/456)).
+- Added ability to change the point of time when calendar events get relative.
+- Add Splash screen on boot.
+- Add option to show humidity in currentWeather module.
+- Add VSCode IntelliSense support.
+- Module API: Add Visibility locking to module system. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#visibility-locking) for more information.
+- Module API: Method to overwrite the module's header. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#getheader) for more information.
+- Module API: Option to define the minimum MagicMirror version to run a module. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#requiresversion) for more information.
+- Calendar module now broadcasts the event list to all other modules using the notification system. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/calendar) for more information.
+- Possibility to use the the calendar feed as the source for the weather (currentweather & weatherforecast) location data. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/weatherforecast) for more information.
+- Added option to show rain amount in the weatherforecast default module
+- Add module `updatenotification` to get an update whenever a new version is available. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/updatenotification) for more information.
+- Add the ability to set timezone on the date display in the Clock Module
+- Ability to set date format in calendar module
+- Possibility to use currentweather for the compliments
+- Added option `disabled` for modules.
+- Added option `address` to set bind address.
+- Added option `onlyTemp` for currentweather module to show show only current temperature and weather icon.
+- Added option `remoteFile` to compliments module to load compliment array from filesystem.
+- Added option `zoom` to scale the whole mirror display with a given factor.
+- Added option `roundTemp` for currentweather and weatherforecast modules to display temperatures rounded to nearest integer.
+- Added abilty set the classes option to compliments module for style and text size of compliments.
+- Added ability to configure electronOptions
+- Calendar module: option to hide private events
+- Add root_path for global vars
+
+### Updated
+- Modified translations for Frysk.
+- Modified core English translations.
+- Updated package.json as a result of Snyk security update.
+- Improve object instantiation to prevent reference errors.
+- Improve logger. `Log.log()` now accepts multiple arguments.
+- Remove extensive logging in newsfeed node helper.
+- Calendar times are now uniformly capitalized.
+- Modules are now secure, and Helmet is now used to prevent abuse of the Mirror's API.
+
+### Fixed
+- Solve an issue where module margins would appear when the first module of a section was hidden.
+- Solved visual display errors on chrome, if all modules in one of the right sections are hidden.
+- Global and Module default config values are no longer modified when setting config values.
+- Hide a region if all modules in a region are hidden. Prevention unwanted margins.
+- Replaced `electron-prebuilt` package with `electron` in order to fix issues that would happen after 2017.
+- Documentation of alert module
+
+## [2.0.5] - 2016-09-20
+
+### Added
+- Added ability to remove tags from the beginning or end of newsfeed items in 'newsfeed.js'.
+- Added ability to define "the day after tomorrow" for calendar events (Definition for German and Dutch already included).
+- Added CII Badge (we are compliant with the CII Best Practices)
+- Add support for doing http basic auth when loading calendars
+- Add the ability to turn off and on the date display in the Clock Module
+
+### Fixed
+- Fix typo in installer.
+- Add message to unsupported Pi error to mention that Pi Zeros must use server only mode, as ARMv6 is unsupported. Closes #374.
+- Fix API url for weather API.
+
+### Updated
+- Force fullscreen when kioskmode is active.
+- Update the .github templates and information with more modern information.
+- Update the Gruntfile with a more functional StyleLint implementation.
+
 ## [2.0.4] - 2016-08-07
 
 ### Added
 - Brazilian Portuguese Translation.
-- Option to enable Kios mode.
+- Option to enable Kiosk mode.
 - Added ability to start the app with Dev Tools.
 - Added ability to turn off the date display in `clock.js` when in analog mode.
 - Greek Translation
 
 ### Fixed
 - Prevent `getModules()` selectors from returning duplicate entries.
-- Append endpoints of weather modules with `/` to retreive the correct data. (Issue [#337](https://github.com/MichMich/MagicMirror/issues/337))
-- Corrected grammer in `module.js` from 'suspend' to 'suspended'.
+- Append endpoints of weather modules with `/` to retrieve the correct data. (Issue [#337](https://github.com/MichMich/MagicMirror/issues/337))
+- Corrected grammar in `module.js` from 'suspend' to 'suspended'.
 - Fixed openweathermap.org URL in config sample.
 - Prevent currentweather module from crashing when received data object is incorrect.
 - Fix issue where translation loading prevented the UI start-up when the language was set to 'en'. (Issue [#388](https://github.com/MichMich/MagicMirror/issues/388))
@@ -47,7 +599,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 - Added reference to Italian Translation.
-- Added the missing NE translation to all languages. [#334](https://github.com/MichMich/MagicMirror/issues/344)
+- Added the missing NE translation to all languages. [#344](https://github.com/MichMich/MagicMirror/issues/344)
 - Added proper User-Agent string to calendar call.
 
 ### Changed
@@ -71,4 +623,4 @@ It includes (but is not limited to) the following features:
 
 ## [1.0.0] - 2014-02-16
 ### Initial release of MagicMirror.
-This was part of the blogpost: http://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the
+This was part of the blogpost: [http://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the](http://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the)

Gruntfile.js

@@ -4,25 +4,102 @@ module.exports = function(grunt) {
 		pkg: grunt.file.readJSON("package.json"),
 		eslint: {
 			options: {
+				fix: "true",
 				configFile: ".eslintrc.json"
 			},
-			target: ["js/*.js", "modules/default/*.js", "serveronly/*.js", "*.js"]
+			target: [
+				"js/*.js",
+				"modules/default/*.js",
+				"modules/default/*/*.js",
+				"serveronly/*.js",
+				"clientonly/*.js",
+				"*.js",
+				"tests/**/*.js",
+				"!modules/default/alert/notificationFx.js",
+				"!modules/default/alert/modernizr.custom.js",
+				"!modules/default/alert/classie.js",
+				"config/*",
+				"translations/translations.js",
+				"vendor/vendor.js",
+				"modules/node_modules/node_helper/index.js"
+			]
 		},
-		postcss: {
-			lint: {
+		stylelint: {
+			simple: {
 				options: {
-					processors: [
-						require("stylelint")({"extends": "stylelint-config-standard", "font-family-name-quotes": "double-where-recommended"}),
-						require("postcss-reporter")({ clearMessages: true })
-					]
+					configFile: ".stylelintrc.json"
 				},
-				dist: {
-					src: "**/**/**/**/**/**/**/**.css"
+				src: [
+					"css/main.css",
+					"modules/default/calendar/calendar.css",
+					"modules/default/clock/clock_styles.css",
+					"modules/default/currentweather/currentweather.css",
+					"modules/default/weatherforcast/weatherforcast.css"
+				]
+			}
+		},
+		jsonlint: {
+			main: {
+				src: [
+					"package.json",
+					".eslintrc.json",
+					".stylelintrc.json",
+					"installers/pm2_MagicMirror.json",
+					"translations/*.json",
+					"modules/default/*/translations/*.json",
+					"vendor/package.json"
+				],
+				options: {
+					reporter: "jshint"
 				}
 			}
+		},
+		markdownlint: {
+			all: {
+				options: {
+					config: {
+						"default": true,
+						"line-length": false,
+						"blanks-around-headers": false,
+						"no-duplicate-header": false,
+						"no-inline-html": false,
+						"MD010": false,
+						"MD001": false,
+						"MD031": false,
+						"MD040": false,
+						"MD002": false,
+						"MD029": false,
+						"MD041": false,
+						"MD032": false,
+						"MD036": false,
+						"MD037": false,
+						"MD009": false,
+						"MD018": false,
+						"MD012": false,
+						"MD026": false,
+						"MD038": false
+					}
+				},
+				src: [
+					"README.md",
+					"CHANGELOG.md",
+					"LICENSE.md",
+					"modules/README.md",
+					"modules/default/**/*.md",
+					"!modules/default/calendar/vendor/ical.js/readme.md"
+				]
+			}
+		},
+		yamllint: {
+			all: [
+				".travis.yml"
+			]
 		}
 	});
 	grunt.loadNpmTasks("grunt-eslint");
-	grunt.loadNpmTasks("grunt-postcss");
-	grunt.registerTask("default", ["eslint", "postcss:lint"]);
-};
+	grunt.loadNpmTasks("grunt-stylelint");
+	grunt.loadNpmTasks("grunt-jsonlint");
+	grunt.loadNpmTasks("grunt-yamllint");
+	grunt.loadNpmTasks("grunt-markdownlint");
+	grunt.registerTask("default", ["eslint", "stylelint", "jsonlint", "markdownlint", "yamllint"]);
+};

LICENSE.md

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 =====================
 
-Copyright © 2016 Michael Teeuw
+Copyright © 2016-2019 Michael Teeuw
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.md

@@ -3,9 +3,9 @@
 <p align="center">
 	<a href="https://david-dm.org/MichMich/MagicMirror"><img src="https://david-dm.org/MichMich/MagicMirror.svg" alt="Dependency Status"></a>
 	<a href="https://david-dm.org/MichMich/MagicMirror#info=devDependencies"><img src="https://david-dm.org/MichMich/MagicMirror/dev-status.svg" alt="devDependency Status"></a>
-	<a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-v5.10.1-brightgreen.svg" alt="Node Version"></a>
+	<a href="https://bestpractices.coreinfrastructure.org/projects/347"><img src="https://bestpractices.coreinfrastructure.org/projects/347/badge"></a>
 	<a href="http://choosealicense.com/licenses/mit"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
-	<a href="https://travis-ci.org/MichMich/MagicMirror"><img src="https://travis-ci.org/MichMich/MagicMirror.svg" alt="Travis"></a>
+	<a href="https://travis-ci.com/MichMich/MagicMirror"><img src="https://travis-ci.com/MichMich/MagicMirror.svg" alt="Travis"></a>
 	<a href="https://snyk.io/test/github/MichMich/MagicMirror"><img src="https://snyk.io/test/github/MichMich/MagicMirror/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/MichMich/MagicMirror" style="max-width:100%;"></a>
 </p>
 
@@ -15,82 +15,146 @@ MagicMirror² focuses on a modular plugin system and uses [Electron](http://elec
 
 ## Table Of Contents
 
-- [Usage](#usage)
+- [Table Of Contents](#table-of-contents)
+- [Installation](#installation)
+  - [Raspberry Pi](#raspberry-pi)
+    - [Automatic Installation (Raspberry Pi only!)](#automatic-installation-raspberry-pi-only)
+    - [Manual Installation](#manual-installation)
+  - [Server Only](#server-only)
+  - [Client Only](#client-only)
+  - [Docker](#docker)
 - [Configuration](#configuration)
+  - [Raspberry Specific](#raspberry-specific)
+  - [General](#general)
 - [Modules](#modules)
-- [Known Issues](#known-issues)
-- [community](#community)
+- [Updating](#updating)
+- [Community](#community)
 - [Contributing Guidelines](#contributing-guidelines)
+- [Enjoying MagicMirror? Consider a donation!](#enjoying-magicmirror-consider-a-donation)
+- [Manifesto](#manifesto)
 
-## Usage
+## Installation
 
-#### Raspberry Pi Support
-Electron, the app wrapper around MagicMirror², only supports the Raspberry Pi 2 & 3. The Raspberry Pi 1 is currently **not** supported. If you want to run this on a Raspberry Pi 1, use the [server only](#server-only) feature and setup a fullscreen browser yourself.
+### Raspberry Pi
 
-#### Automatic Installer (Raspberry Pi Only!)
+#### Automatic Installation (Raspberry Pi only!)
+
+*Electron*, the app wrapper around MagicMirror², only supports the Raspberry Pi 2/3. The Raspberry Pi 0/1 is currently **not** supported. If you want to run this on a Raspberry Pi 1, use the [server only](#server-only) feature and setup a fullscreen browser yourself. (Yes, people have managed to run MM² also on a Pi0, so if you insist, search in the forums.)
+
+Note that you will need to install the latest full version of Raspbian, **don't use the Lite version**.
 
 Execute the following command on your Raspberry Pi to install MagicMirror²:
-````
-curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/master/installers/raspberry.sh | bash
-````
+
+```bash
+bash -c "$(curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/master/installers/raspberry.sh)"
+```
 
 #### Manual Installation
 
-1. Download and install the latest Node.js version.
-2. Clone the repository and check out the beta branch: `git clone https://github.com/MichMich/MagicMirror`
-3. Enter the repository: `cd ~/MagicMirror`
-4. Install and run the app: `npm install && npm start`
+1. Download and install the latest *Node.js* version:
+- `curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -`
+- `sudo apt install -y nodejs`
+2. Clone the repository and check out the master branch: `git clone https://github.com/MichMich/MagicMirror`
+3. Enter the repository: `cd MagicMirror/`
+4. Install and run the app with: `npm install && npm start` \
+   For **Server Only** use: `npm install && node serveronly` .
 
-**Important:** `npm start` does **not** work via SSH, use `DISPLAY=:0 nohup npm start &` instead. This starts the mirror on the remote display.
 
-**Note:** if you want to debug on Raspberry Pi you can use `npm start dev` which will start the MagicMirror app with Dev Tools enabled.
+**:warning: Important!**
 
-#### Server Only
+- **The installation step for `npm install` will take a very long time**, often with little or no terminal response! \
+  For the RPi3 this is **~10** minutes and for the Rpi2 **~25** minutes. \
+  Do not interrupt or you risk getting a :broken_heart: by Raspberry Jam.
 
-In some cases, you want to start the application without an actual app window. In this case, execute the following command from the MagicMirror folder: `node serveronly`. This will start the server, after which you can open the application in your browser of choice.
 
-#### Raspberry Configuration & Auto Start.
+Also note that:
 
-The following wiki links are helpful in the configuration of your MagicMirror² operating system:
-- [Configuring the Raspberry Pi](https://github.com/MichMich/MagicMirror/wiki/Configuring-the-Raspberry-Pi)
-- [Auto Starting MagicMirror](https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror)
+- `npm start` does **not** work via SSH. But you can use `DISPLAY=:0 nohup npm start &` instead. \
+  This starts the mirror on the remote display.
+- If you want to debug on Raspberry Pi you can use `npm start dev` which will start MM with *Dev Tools* enabled.
+- To access toolbar menu when in mirror mode, hit `ALT` key.
+- To toggle the (web) `Developer Tools` from mirror mode, use `CTRL-SHIFT-I` or `ALT` and select `View`.
 
-#### Updating you MagicMirror²
 
-If you want to update your MagicMirror² to the latest version, use your terminal to go to your Magic Mirror folder and type the following command:
+### Server Only
 
-````
-git pull
-````
+In some cases, you want to start the application without an actual app window. In this case, you can start MagicMirror² in server only mode by manually running `node serveronly` or using Docker. This will start the server, after which you can open the application in your browser of choice. Detailed description below.
+
+**Important:** Make sure that you whitelist the interface/ip (`ipWhitelist`) in the server config where you want the client to connect to, otherwise it will not be allowed to connect to the server. You also need to set the local host `address` field to `0.0.0.0` in order for the RPi to listen on all interfaces and not only `localhost` (default).
+
+```javascript
+var config = {
+	address: "0.0.0.0",	// default is "localhost"
+	port: 8080,		// default
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:172.17.0.1"], // default -- need to add your IP here
+	...
+};
+```
+
+
+### Client Only
+
+This is when you already have a server running remotely and want your RPi to connect as a standalone client to this instance, to show the MM from the server. Then from your RPi, you run it with: `node clientonly --address 192.168.1.5 --port 8080`. (Specify the ip address and port number of the server)
+
+
+### Docker
+
+MagicMirror² in server only mode can be deployed using [Docker](https://docker.com). After a successful [Docker installation](https://docs.docker.com/engine/installation/) you just need to execute the following command in the shell:
+
+```bash
+docker run  -d \
+	--publish 80:8080 \
+	--restart always \
+	--volume ~/magic_mirror/config:/opt/magic_mirror/config \
+	--volume ~/magic_mirror/modules:/opt/magic_mirror/modules \
+	--name magic_mirror \
+	bastilimbach/docker-magicmirror
+```
+To get more information about the available Dockerfile versions and configurations head over to the respective [GitHub repository](https://github.com/bastilimbach/docker-MagicMirror).
 
-If you changed nothing more than the config or the modules, this should work without any problems.
-Type `git status` to see your changes, if there are any, you can reset them with `git reset --hard`. After that, git pull should be possible.
 
 ## Configuration
 
-1. Duplicate `config/config.js.sample` to `config/config.js`.
-2. Modify your required settings.
+### Raspberry Specific
+
+The following wiki links are helpful for the initial configuration of your MagicMirror² operating system:
+- [Configuring the Raspberry Pi](https://github.com/MichMich/MagicMirror/wiki/Configuring-the-Raspberry-Pi)
+- [Auto Starting MagicMirror](https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror)
+
+
+### General
+
+1. Copy `/home/pi/MagicMirror/config/config.js.sample` to `/home/pi/MagicMirror/config/config.js`. \
+   **Note:** If you used the installer script. This step is already done for you.
+
+2. Modify your required settings. \
+   Note: You can check your configuration running `npm run config:check` in `/home/pi/MagicMirror`.
+
 
 The following properties can be configured:
 
-
 | **Option** | **Description** |
 | --- | --- |
 | `port` | The port on which the MagicMirror² server will run on. The default value is `8080`. |
-| `kioskmode` | This allows MagicMirror² to run in Kiosk Mode. It protects from other programs popping on top of your screen. The default value is `false`|
+| `address` | The *interface* ip address on which to accept connections. The default is `localhost`, which would prevent exposing the built-in webserver to machines on the local network. To expose it to other machines, use: `0.0.0.0`. |
+| `ipWhitelist` | The list of IPs from which you are allowed to access the MagicMirror². The default value is `["127.0.0.1", "::ffff:127.0.0.1", "::1"]`, which is from `localhost` only. Add your IP when needed. You can also specify IP ranges with subnet masks (`["127.0.0.1", "127.0.0.1/24"]`) or directly with (`["127.0.0.1", ["192.168.0.1", "192.168.0.100"]]`). Set `[]` to allow all IP addresses. For more information see: [follow post ipWhitelist HowTo](https://forum.magicmirror.builders/topic/1326/ipwhitelist-howto) |
+| `zoom` | This allows to scale the mirror contents with a given zoom factor. The default value is `1.0`|
 | `language` | The language of the interface. (Note: Not all elements will be localized.) Possible values are `en`, `nl`, `ru`, `fr`, etc., but the default value is `en`. |
 | `timeFormat` | The form of time notation that will be used. Possible values are `12` or `24`. The default is `24`. |
 | `units` | The units that will be used in the default weather modules. Possible values are `metric` or `imperial`. The default is `metric`. |
 | `modules` | An array of active modules. **The array must contain objects. See the next table below for more information.** |
+| `electronOptions` | An optional array of Electron (browser) options. This allows configuration of e.g. the browser screen size and position (example: `electronOptions: { fullscreen: false, width: 800, height: 600 }`). Kiosk mode can be enabled by setting `kiosk: true`, `autoHideMenuBar: false` and `fullscreen: false`. More options can be found [here](https://github.com/electron/electron/blob/master/docs/api/browser-window.md). |
+| `customCss` | The path of the `custom.css` stylesheet. The default is `css/custom.css`. |
 
 Module configuration:
 
 | **Option** | **Description** |
 | --- | --- |
 | `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `default/calendar` and `custommodules/mymodule`. |
-| `position` | The location of the module in which the module will be loaded. Possible values are `top_ bar`, `top_left`, `top_center`, `top_right`, `upper_third`, `middle_center`, `lower_third`, `bottom_left`, `bottom_center`, `bottom_right`, `bottom_bar`, `fullscreen_above`, and `fullscreen_below`. This field is optional but most modules require this field to set. Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file. |
+| `position` | The location of the module in which the module will be loaded. Possible values are `top_bar`, `top_left`, `top_center`, `top_right`, `upper_third`, `middle_center`, `lower_third`, `bottom_left`, `bottom_center`, `bottom_right`, `bottom_bar`, `fullscreen_above`, and `fullscreen_below`. This field is optional but most modules require this field to set. Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file. |
 | `classes` | Additional classes which are passed to the module. The field is optional. |
 | `header` | To display a header text above the module, add the header property. This field is optional. |
+| `disabled` | Set disabled to `true` to skip creating the module. This field is optional. |
 | `config` | An object with the module configuration properties. Check the documentation of the module for more information. This field is optional, unless the module requires extra configuration. |
 
 ## Modules
@@ -106,12 +170,20 @@ The following modules are installed by default.
 - [**Hello World**](modules/default/helloworld)
 - [**Alert**](modules/default/alert)
 
-For more available modules, check out out the wiki page: [MagicMirror² Modules](https://github.com/MichMich/MagicMirror/wiki/MagicMirror²-Modules). If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](modules) and don't forget to add it to the wiki and the [forum](https://forum.magicmirror.builders/category/7/showcase)!
+For more available modules, check out out the wiki page [MagicMirror² 3rd Party Modules](https://github.com/MichMich/MagicMirror/wiki/3rd-party-modules). If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](modules) and don't forget to add it to the wiki and the [forum](https://forum.magicmirror.builders/category/7/showcase)!
 
-## Known issues
 
-- Electron seems to have some issues on certain Raspberry Pi 2's. See [#145](https://github.com/MichMich/MagicMirror/issues/145).
-- MagicMirror² (Electron) sometimes quits without an error after an extended period of use. See [#150](https://github.com/MichMich/MagicMirror/issues/150).
+## Updating
+
+If you want to update your MagicMirror² to the latest version, use your terminal to go to your Magic Mirror folder and type the following command:
+
+```bash
+git pull && npm install
+```
+
+If you changed nothing more than the config or the modules, this should work without any problems.
+Type `git status` to see your changes, if there are any, you can reset them with `git reset --hard`. After that, git pull should be possible.
+
 
 ## Community
 
@@ -129,3 +201,34 @@ Please keep the following in mind:
 - **New Features**: please please discuss in a GitHub issue before you start to alter a big part of the code. Without discussion upfront, the pull request will not be accepted / merged.
 
 Thanks for your help in making MagicMirror² better!
+
+
+## Enjoying MagicMirror? Consider a donation!
+
+MagicMirror² is opensource and free. That doesn't mean we don't need any money.
+
+Please consider a donation to help us cover the ongoing costs like webservers and email services.
+If we receive enough donations we might even be able to free up some working hours and spend some extra time improving the MagicMirror² core.
+
+To donate, please follow [this](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G5D8E9MR5DTD2&source=url) link.
+
+## Manifesto
+
+A real Manifesto is still to be written. Till then, Michael's response on [one of the repository issues](https://github.com/MichMich/MagicMirror/issues/1174) gives a great summary:
+
+> "... I started this project as an ultimate starter project for Raspberry Pi enthusiasts. As a matter of fact, for most of the contributors, the MagicMirror project is the first open source project they ever contributed to. This is one of the reasons why the MagicMirror project is featured in several RasPi magazines.
+>
+>The project has a lot of opportunities for improvement. We could use a powerful framework like Vue to ramp up the development speed. We could use SASS for better/easier css implementations. We could make it an NPM installable package. And as you say, we could bundle it up. The big downside of of of these changes is that it over complicates things: a user no longer will be able to open just one file and make a small modification and see how it works out.
+>
+>Of course, a bundled version can be complimentary to the regular un-bundled version. And I'm sure a lot of (new) users will opt for the bundled version. But this means those users won't be motivated to take a peek under the hood. They will just remain 'users'. They won't become contributors, and worse: they won't be motivated to take their first steps in software development.
+>
+>And to be honest: motivating curious users to step out of their comfort zone and take those first steps is what drives me in this project. Therefor my ultimate goal is this project is to keep it as accessible as possible."
+>
+> ~ Michael Teeuw
+
+
+
+<p align="center">
+<br>
+	<a href="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><img src="https://magicmirror.builders/img/magpi-best-watermark-custom.png" width="150" alt="MagPi Top 50"></a>
+</p>

clientonly/index.js

@@ -0,0 +1,104 @@
+/* jshint esversion: 6 */
+
+"use strict";
+
+// Use separate scope to prevent global scope pollution
+(function () {
+	var config = {};
+
+	// Helper function to get server address/hostname from either the commandline or env
+	function getServerAddress() {
+		// Helper function to get command line parameters
+		// Assumes that a cmdline parameter is defined with `--key [value]`
+		function getCommandLineParameter(key, defaultValue = undefined) {
+			var index = process.argv.indexOf(`--${key}`);
+			var value = index > -1 ? process.argv[index + 1] : undefined;
+			return value !== undefined ? String(value) : defaultValue;
+		}
+
+		// Prefer command line arguments over environment variables
+		["address", "port"].forEach((key) => {
+			config[key] = getCommandLineParameter(key, process.env[key.toUpperCase()]);
+		});
+	}
+
+	function getServerConfig(url) {
+		// Return new pending promise
+		return new Promise((resolve, reject) => {
+			// Select http or https module, depending on reqested url
+			const lib = url.startsWith("https") ? require("https") : require("http");
+			const request = lib.get(url, (response) => {
+				var configData = "";
+
+				// Gather incoming data
+				response.on("data", function(chunk) {
+					configData += chunk;
+				});
+				// Resolve promise at the end of the HTTP/HTTPS stream
+				response.on("end", function() {
+					resolve(JSON.parse(configData));
+				});
+			});
+
+			request.on("error", function(error) {
+				reject(new Error(`Unable to read config from server (${url} (${error.message}`));
+			});
+		});
+	}
+
+	function fail(message, code = 1) {
+		if (message !== undefined && typeof message === "string") {
+			console.log(message);
+		} else {
+			console.log("Usage: 'node clientonly --address 192.168.1.10 --port 8080'");
+		}
+		process.exit(code);
+	}
+
+	getServerAddress();
+
+	(config.address && config.port) || fail();
+
+	// Only start the client if a non-local server was provided
+	if (["localhost", "127.0.0.1", "::1", "::ffff:127.0.0.1", undefined].indexOf(config.address) === -1) {
+		getServerConfig(`http://${config.address}:${config.port}/config/`)
+			.then(function (configReturn) {
+				// Pass along the server config via an environment variable
+				var env = Object.create(process.env);
+				var options = { env: env };
+				configReturn.address = config.address;
+				configReturn.port = config.port;
+				env.config = JSON.stringify(configReturn);
+
+				// Spawn electron application
+				const electron = require("electron");
+				const child = require("child_process").spawn(electron, ["js/electron.js"], options);
+
+				// Pipe all child process output to current stdout
+				child.stdout.on("data", function (buf) {
+					process.stdout.write(`Client: ${buf}`);
+				});
+
+				// Pipe all child process errors to current stderr
+				child.stderr.on("data", function (buf) {
+					process.stderr.write(`Client: ${buf}`);
+				});
+
+				child.on("error", function (err) {
+					process.stdout.write(`Client: ${err}`);
+				});
+
+				child.on("close", (code) => {
+					if (code !== 0) {
+						console.log(`There something wrong. The clientonly is not running code ${code}`);
+					}
+				});
+
+			})
+			.catch(function (reason) {
+				fail(`Unable to connect to server: (${reason})`);
+			});
+	} else {
+		fail();
+	}
+}());

config/config.js.sample

@@ -2,62 +2,79 @@
  *
  * By Michael Teeuw http://michaelteeuw.nl
  * MIT Licensed.
+ *
+ * For more information how you can configurate this file
+ * See https://github.com/MichMich/MagicMirror#configuration
+ *
  */
 
 var config = {
+	address: "localhost", // Address to listen on, can be:
+	                      // - "localhost", "127.0.0.1", "::1" to listen on loopback interface
+	                      // - another specific IPv4/6 to listen on a specific interface
+	                      // - "", "0.0.0.0", "::" to listen on any interface
+	                      // Default, when address config is left out, is "localhost"
 	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], // Set [] to allow all IP addresses
+	                                                       // or add a specific IPv4 of 192.168.1.5 :
+	                                                       // ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.1.5"],
+	                                                       // or IPv4 range of 192.168.3.0 --> 192.168.3.15 use CIDR format :
+	                                                       // ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.3.0/28"],
 
-	language: 'en',
+	language: "en",
 	timeFormat: 24,
-	units: 'metric',
+	units: "metric",
 
 	modules: [
 		{
-			module: 'alert',
+			module: "alert",
 		},
 		{
-			module: 'clock',
-			position: 'top_left'
+			module: "updatenotification",
+			position: "top_bar"
 		},
 		{
-			module: 'calendar',
-			header: 'US Holidays',
-			position: 'top_left',
+			module: "clock",
+			position: "top_left"
+		},
+		{
+			module: "calendar",
+			header: "US Holidays",
+			position: "top_left",
 			config: {
 				calendars: [
 					{
-						symbol: 'calendar-check-o ',
-						url: 'webcal://www.calendarlabs.com/templates/ical/US-Holidays.ics'
-					}
+						symbol: "calendar-check",
+						url: "webcal://www.calendarlabs.com/ical-calendar/ics/76/US_Holidays.ics"					}
 				]
 			}
 		},
 		{
-			module: 'compliments',
-			position: 'lower_third'
+			module: "compliments",
+			position: "lower_third"
 		},
 		{
-			module: 'currentweather',
-			position: 'top_right',
+			module: "currentweather",
+			position: "top_right",
 			config: {
-				location: 'New York',
-				locationID: '',  //ID from http://www.openweathermap.org
-				appid: 'YOUR_OPENWEATHER_API_KEY'
+				location: "New York",
+				locationID: "",  //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
+				appid: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},
 		{
-			module: 'weatherforecast',
-			position: 'top_right',
-			header: 'Weather Forecast',
+			module: "weatherforecast",
+			position: "top_right",
+			header: "Weather Forecast",
 			config: {
-	            location: 'New York',
-				locationID: '5128581',  //ID from http://www.openweathermap.org
-	            appid: 'YOUR_OPENWEATHER_API_KEY'
+				location: "New York",
+				locationID: "5128581",  //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
+				appid: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},
 		{
-			module: 'newsfeed',
-			position: 'bottom_bar',
+			module: "newsfeed",
+			position: "bottom_bar",
 			config: {
 				feeds: [
 					{
@@ -66,7 +83,9 @@ var config = {
 					}
 				],
 				showSourceTitle: true,
-				showPublishDate: true
+				showPublishDate: true,
+				broadcastNewsFeeds: true,
+				broadcastNewsUpdates: true
 			}
 		},
 	]
@@ -74,4 +93,4 @@ var config = {
 };
 
 /*************** DO NOT EDIT THE LINE BELOW ***************/
-if (typeof module !== 'undefined') {module.exports = config;}
+if (typeof module !== "undefined") {module.exports = config;}

css/main.css

@@ -1,10 +1,11 @@
 html {
   cursor: none;
-  overflow:hidden;
+  overflow: hidden;
+  background: #000;
 }
 
-::-webkit-scrollbar { 
-    display: none; 
+::-webkit-scrollbar {
+  display: none;
 }
 
 body {
@@ -94,7 +95,7 @@ body {
 header {
   text-transform: uppercase;
   font-size: 15px;
-  font-family: "Roboto Condensed";
+  font-family: "Roboto Condensed", Arial, Helvetica, sans-serif;
   font-weight: 400;
   border-bottom: 1px solid #666;
   line-height: 15px;
@@ -113,11 +114,22 @@ sup {
  */
 
 .module {
-  margin-top: 30px;
+  margin-bottom: 30px;
 }
 
-.module:first-child {
-  margin-top: 0;
+.region.bottom .module {
+  margin-top: 30px;
+  margin-bottom: 0;
+}
+
+.no-wrap {
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+}
+
+.pre-line {
+  white-space: pre-line;
 }
 
 /**
@@ -134,10 +146,16 @@ sup {
   left: -60px;
   right: -60px;
   bottom: -60px;
+  pointer-events: none;
+}
+
+.region.fullscreen * {
+  pointer-events: auto;
 }
 
 .region.right {
   right: 0;
+  text-align: right;
 }
 
 .region.top {
@@ -148,6 +166,10 @@ sup {
   margin-bottom: 25px;
 }
 
+.region.bottom .container {
+  margin-top: 25px;
+}
+
 .region.top .container:empty {
   margin-bottom: 0;
 }
@@ -172,10 +194,6 @@ sup {
   bottom: 0;
 }
 
-.region.bottom .container {
-  margin-top: 25px;
-}
-
 .region.bottom .container:empty {
   margin-top: 0;
 }
@@ -218,10 +236,6 @@ sup {
   text-align: left;
 }
 
-.region.right {
-  text-align: right;
-}
-
 .region table {
   width: 100%;
   border-spacing: 0;

dangerfile.js

@@ -0,0 +1,17 @@
+import { danger, fail, warn } from "danger";
+
+// Check if the CHANGELOG.md file has been edited
+// Fail the build and post a comment reminding submitters to do so if it wasn't changed
+if (!danger.git.modified_files.includes("CHANGELOG.md")) {
+	warn("Please include an updated `CHANGELOG.md` file.<br>This way we can keep track of all the contributions.");
+}
+
+// Check if the PR request is send to the master branch.
+// This should only be done by MichMich.
+if (danger.github.pr.base.ref === "master" && danger.github.pr.user.login !== "MichMich") {
+	// Check if the PR body or title includes the text: #accepted.
+	// If not, the PR will fail.
+	if ((danger.github.pr.body + danger.github.pr.title).includes("#accepted")) {
+		fail("Please send all your pull requests to the `develop` branch.<br>Pull requests on the `master` branch will not be accepted.");
+	}
+}

fonts/LICENSE.txt

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

fonts/package-lock.json

@@ -0,0 +1,12 @@
+{
+  "name": "magicmirror-fonts",
+  "requires": true,
+  "lockfileVersion": 1,
+  "dependencies": {
+    "roboto-fontface": {
+      "version": "0.8.0",
+      "resolved": "https://registry.npmjs.org/roboto-fontface/-/roboto-fontface-0.8.0.tgz",
+      "integrity": "sha512-ZYzRkETgBrdEGzL5JSKimvjI2CX7ioyZCkX2BpcfyjqI+079W0wHAyj5W4rIZMcDSOHgLZtgz1IdDi/vU77KEQ=="
+    }
+  }
+}

fonts/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "magicmirror-fonts",
+  "description": "Package for fonts use by MagicMirror Core.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MichMich/MagicMirror.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/MichMich/MagicMirror/issues"
+  },
+  "dependencies": {
+    "roboto-fontface": "^0.8.0"
+  }
+}

fonts/roboto.css

@@ -5,9 +5,9 @@
   src:
     local("Roboto Thin"),
     local("Roboto-Thin"),
-    url("Roboto-Thin/Roboto-Thin.woff2") format("woff2"),
-    url("Roboto-Thin/Roboto-Thin.woff") format("woff"),
-    url("Roboto-Thin/Roboto-Thin.ttf") format("truetype");
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Thin.woff2") format("woff2"),
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Thin.woff") format("woff"),
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Thin.ttf") format("truetype");
 }
 
 @font-face {
@@ -17,9 +17,9 @@
   src:
     local("Roboto Condensed Light"),
     local("RobotoCondensed-Light"),
-    url("RobotoCondensed-Light/RobotoCondensed-Light.woff2") format("woff2"),
-    url("RobotoCondensed-Light/RobotoCondensed-Light.woff") format("woff"),
-    url("RobotoCondensed-Light/RobotoCondensed-Light.ttf") format("truetype");
+    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Light.woff2") format("woff2"),
+    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Light.woff") format("woff"),
+    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Light.ttf") format("truetype");
 }
 
 @font-face {
@@ -29,9 +29,9 @@
   src:
     local("Roboto Condensed"),
     local("RobotoCondensed-Regular"),
-    url("RobotoCondensed-Regular/RobotoCondensed-Regular.woff2") format("woff2"),
-    url("RobotoCondensed-Regular/RobotoCondensed-Regular.woff") format("woff"),
-    url("RobotoCondensed-Regular/RobotoCondensed-Regular.ttf") format("truetype");
+    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Regular.woff2") format("woff2"),
+    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Regular.woff") format("woff"),
+    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Regular.ttf") format("truetype");
 }
 
 @font-face {
@@ -41,9 +41,9 @@
   src:
     local("Roboto Condensed Bold"),
     local("RobotoCondensed-Bold"),
-    url("RobotoCondensed-Bold/RobotoCondensed-Bold.woff2") format("woff2"),
-    url("RobotoCondensed-Bold/RobotoCondensed-Bold.woff") format("woff"),
-    url("RobotoCondensed-Bold/RobotoCondensed-Bold.ttf") format("truetype");
+    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Bold.woff2") format("woff2"),
+    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Bold.woff") format("woff"),
+    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Bold.ttf") format("truetype");
 }
 
 @font-face {
@@ -53,9 +53,9 @@
   src:
     local("Roboto"),
     local("Roboto-Regular"),
-    url("Roboto-Regular/Roboto-Regular.woff2") format("woff2"),
-    url("Roboto-Regular/Roboto-Regular.woff") format("woff"),
-    url("Roboto-Regular/Roboto-Regular.ttf") format("truetype");
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Regular.woff2") format("woff2"),
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Regular.woff") format("woff"),
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Regular.ttf") format("truetype");
 }
 
 @font-face {
@@ -65,9 +65,9 @@
   src:
     local("Roboto Medium"),
     local("Roboto-Medium"),
-    url("Roboto-Medium/Roboto-Medium.woff2") format("woff2"),
-    url("Roboto-Medium/Roboto-Medium.woff") format("woff"),
-    url("Roboto-Medium/Roboto-Medium.ttf") format("truetype");
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Medium.woff2") format("woff2"),
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Medium.woff") format("woff"),
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Medium.ttf") format("truetype");
 }
 
 @font-face {
@@ -77,9 +77,9 @@
   src:
     local("Roboto Bold"),
     local("Roboto-Bold"),
-    url("Roboto-Bold/Roboto-Bold.woff2") format("woff2"),
-    url("Roboto-Bold/Roboto-Bold.woff") format("woff"),
-    url("Roboto-Bold/Roboto-Bold.ttf") format("truetype");
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Bold.woff2") format("woff2"),
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Bold.woff") format("woff"),
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Bold.ttf") format("truetype");
 }
 
 @font-face {
@@ -89,7 +89,7 @@
   src:
     local("Roboto Light"),
     local("Roboto-Light"),
-    url("Roboto-Light/Roboto-Light.woff2") format("woff2"),
-    url("Roboto-Light/Roboto-Light.woff") format("woff"),
-    url("Roboto-Light/Roboto-Light.ttf") format("truetype");
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Light.woff2") format("woff2"),
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Light.woff") format("woff"),
+    url("node_modules/roboto-fontface/fonts/roboto/Roboto-Light.ttf") format("truetype");
 }

fonts/yarn.lock

@@ -0,0 +1,7 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+roboto-fontface@^0.8.0:
+  version "0.8.0"
+  resolved "https://registry.yarnpkg.com/roboto-fontface/-/roboto-fontface-0.8.0.tgz#031a83c8f79932801a57d83bf743f37250163499"

index.html

@@ -1,13 +1,23 @@
 <!DOCTYPE html>
 <html>
 <head>
-	<title>Magic Mirror</title>
+	<title>MagicMirror²</title>
 	<meta name="google" content="notranslate" />
 	<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+
+	<meta name="apple-mobile-web-app-capable" content="yes">
+	<meta name="apple-mobile-web-app-status-bar-style" content="black">
+	<meta name="format-detection" content="telephone=no">
+	<meta name="mobile-web-app-capable" content="yes">
+
 	<link rel="icon" href="data:;base64,iVBORw0KGgo=">
 	<link rel="stylesheet" type="text/css" href="css/main.css">
 	<link rel="stylesheet" type="text/css" href="fonts/roboto.css">
 	<!-- custom.css is loaded by the loader.js to make sure it's loaded after the module css files. -->
+
+	<script type="text/javascript">
+		var version = "#VERSION#";
+	</script>
 </head>
 <body>
 	<div class="region fullscreen below"><div class="container"></div></div>
@@ -28,8 +38,9 @@
 	</div>
 	<div class="region fullscreen above"><div class="container"></div></div>
 	<script type="text/javascript" src="/socket.io/socket.io.js"></script>
+	<script type="text/javascript" src="vendor/node_modules/nunjucks/browser/nunjucks.min.js"></script>
 	<script type="text/javascript" src="js/defaults.js"></script>
-	<script type="text/javascript" src="config/config.js"></script>
+	<script type="text/javascript" src="#CONFIG_FILE#"></script>
 	<script type="text/javascript" src="vendor/vendor.js"></script>
 	<script type="text/javascript" src="modules/default/defaultmodules.js"></script>
 	<script type="text/javascript" src="js/logger.js"></script>

installers/mm.sh

@@ -0,0 +1,2 @@
+cd ~/MagicMirror
+DISPLAY=:0 npm start

installers/pm2_MagicMirror.json

@@ -0,0 +1,7 @@
+{
+  "apps" : [{
+    "name"        : "MagicMirror",
+    "script"      : "/home/pi/MagicMirror/installers/mm.sh",
+    "watch"       : ["/home/pi/MagicMirror/config/config.js"]
+  }]
+}

installers/postinstall/postinstall.sh

@@ -0,0 +1,2 @@
+echo "\033[32mMagicMirror installation successful!"
+exit 0

installers/raspberry.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/bin/bash
 
 # This is an installer script for MagicMirror2. It works well enough
 # that it can detect if you have Node installed, run a binary script
@@ -18,26 +18,39 @@ echo '                       \$$$$$$  |'
 echo '                        \______/'
 echo -e "\e[0m"
 
-# Define the tested version of Node.js. 
+# Define the tested version of Node.js.
 NODE_TESTED="v5.1.0"
+NPM_TESTED="V6.0.0"
+USER=`whoami`
+PM2_FILE=~/MagicMirror/installers/pm2_MagicMirror.json
 
-#Determine which Pi is running.
+# Determine which Pi is running.
 ARM=$(uname -m) 
 
-#Check the Raspberry Pi version.
+# Check the Raspberry Pi version.
 if [ "$ARM" != "armv7l" ]; then
-	echo -e "\e[91mSorry, your Raspberry Pi is not supported."
-	echo -e "\e[91mPlease run MagicMirror on a Raspberry Pi 2 or 3."
+  read -p "this appears not to be a Raspberry Pi 2 or 3, do you want to continue installtion (y/N)?" choice 
+	if [[ $choice =~ ^[Nn]$ ]]; then 
+		echo -e "\e[91mSorry, your Raspberry Pi is not supported."
+		echo -e "\e[91mPlease run MagicMirror on a Raspberry Pi 2 or 3."
+		echo -e "\e[91mIf this is a Pi Zero, you are in the same boat as the original Raspberry Pi. You must run in server only mode."
 	exit;
+	fi
 fi
 
-#define helper methods.
-function version_gt() { test "$(echo "$@" | tr " " "\n" | sort -V | head -n 1)" != "$1"; }
+    
+# Define helper methods.
 function command_exists () { type "$1" &> /dev/null ;}
+function verlte() {  [ "$1" = "`echo -e "$1\n$2" | sort -V | head -n1`" ];}
+function verlt() { [ "$1" = "$2" ] && return 1 || verlte $1 $2 ;}
+
+# Update before first apt-get
+echo -e "\e[96mUpdating packages ...\e[90m"
+sudo apt-get update || echo -e "\e[91mUpdate failed, carrying on installation ...\e[90m"
 
 # Installing helper tools
 echo -e "\e[96mInstalling helper tools ...\e[90m"
-sudo apt-get install curl wget git build-essential unzip || exit
+sudo apt-get --assume-yes install curl wget git build-essential unzip || exit
 
 # Check if we need to install or upgrade Node.js.
 echo -e "\e[96mCheck current Node installation ...\e[0m"
@@ -47,20 +60,20 @@ if command_exists node; then
 	NODE_CURRENT=$(node -v)
 	echo -e "\e[0mMinimum Node version: \e[1m$NODE_TESTED\e[0m"
 	echo -e "\e[0mInstalled Node version: \e[1m$NODE_CURRENT\e[0m"
-	if version_gt $NODE_TESTED $NODE_CURRENT; then
-    	echo -e "\e[96mNode should be upgraded.\e[0m"
-    	NODE_INSTALL=true
+	if verlte $NODE_CURRENT $NODE_TESTED; then
+		echo -e "\e[96mNode should be upgraded.\e[0m"
+		NODE_INSTALL=true
 
-    	#Check if a node process is currenlty running.
-    	#If so abort installation.
-    	if pgrep "node" > /dev/null; then
-		    echo -e "\e[91mA Node process is currently running. Can't upgrade."
-		    echo "Please quit all Node processes and restart the installer."
-		    exit;
+		# Check if a node process is currenlty running.
+		# If so abort installation.
+		if pgrep "node" > /dev/null; then
+			echo -e "\e[91mA Node process is currently running. Can't upgrade."
+			echo "Please quit all Node processes and restart the installer."
+			exit;
 		fi
 
-    else
-    	echo -e "\e[92mNo Node.js upgrade nessecery.\e[0m"
+	else
+		echo -e "\e[92mNo Node.js upgrade necessary.\e[0m"
 	fi
 
 else
@@ -68,22 +81,60 @@ else
 	NODE_INSTALL=true
 fi
 
-# Install or upgare node if nessecery.
+# Install or upgrade node if necessary.
 if $NODE_INSTALL; then
 	
 	echo -e "\e[96mInstalling Node.js ...\e[90m"
 
-	#Fetch the latest version of Node.js from the selected branch
-	#The NODE_STABLE_BRANCH variable will need to be manually adjusted when a new branch is released. (e.g. 7.x)
-	#Only tested (stable) versions are recommended as newer versions could break MagicMirror.
+	# Fetch the latest version of Node.js from the selected branch
+	# The NODE_STABLE_BRANCH variable will need to be manually adjusted when a new branch is released. (e.g. 7.x)
+	# Only tested (stable) versions are recommended as newer versions could break MagicMirror.
 	
-	NODE_STABLE_BRANCH="6.x"
-	curl -sL https://deb.nodesource.com/setup_$NODE_STABLE_BRANCH | sudo -E bash -
-	sudo apt-get install -y nodejs
+	NODE_STABLE_BRANCH="10.x"
+ 	curl -sL https://deb.nodesource.com/setup_$NODE_STABLE_BRANCH | sudo -E bash -
+ 	sudo apt-get install -y nodejs
 	echo -e "\e[92mNode.js installation Done!\e[0m"
 fi
 
-#Install magic mirror
+# Check if we need to install or upgrade npm.
+echo -e "\e[96mCheck current NPM installation ...\e[0m"
+NPM_INSTALL=false
+if command_exists npm; then
+	echo -e "\e[0mNPM currently installed. Checking version number.";
+	NPM_CURRENT='V'$(npm -v)
+	echo -e "\e[0mMinimum npm version: \e[1m$NPM_TESTED\e[0m"
+	echo -e "\e[0mInstalled npm version: \e[1m$NPM_CURRENT\e[0m"
+	if verlte $NPM_CURRENT $NPM_TESTED; then
+		echo -e "\e[96mnpm should be upgraded.\e[0m"
+		NPM_INSTALL=true
+
+		# Check if a node process is currently running.
+		# If so abort installation.
+		if pgrep "npm" > /dev/null; then
+			echo -e "\e[91mA npm process is currently running. Can't upgrade."
+			echo "Please quit all npm processes and restart the installer."
+			exit;
+		fi
+
+	else
+		echo -e "\e[92mNo npm upgrade necessary.\e[0m"
+	fi
+
+else
+	echo -e "\e[93mnpm is not installed.\e[0m";
+	NPM_INSTALL=true
+fi
+
+# Install or upgrade node if necessary.
+if $NPM_INSTALL; then
+	
+	echo -e "\e[96mInstalling npm ...\e[90m"
+
+  sudo apt-get install -y npm
+	echo -e "\e[92mnpm installation Done!\e[0m"
+fi
+
+# Install MagicMirror
 cd ~
 if [ -d "$HOME/MagicMirror" ] ; then
 	echo -e "\e[93mIt seems like MagicMirror is already installed."
@@ -96,7 +147,7 @@ if [ -d "$HOME/MagicMirror" ] ; then
 fi
 
 echo -e "\e[96mCloning MagicMirror ...\e[90m"
-if git clone https://github.com/MichMich/MagicMirror.git; then 
+if git clone --depth=1 https://github.com/MichMich/MagicMirror.git; then 
 	echo -e "\e[92mCloning MagicMirror Done!\e[0m"
 else
 	echo -e "\e[91mUnable to clone MagicMirror."
@@ -112,6 +163,74 @@ else
 	exit;
 fi
 
+# Use sample config for start MagicMirror
+cp config/config.js.sample config/config.js
+
+# Check if plymouth is installed (default with PIXEL desktop environment), then install custom splashscreen.
+echo -e "\e[96mCheck plymouth installation ...\e[0m"
+if command_exists plymouth; then
+	THEME_DIR="/usr/share/plymouth/themes"
+	echo -e "\e[90mSplashscreen: Checking themes directory.\e[0m"
+	if [ -d $THEME_DIR ]; then
+		echo -e "\e[90mSplashscreen: Create theme directory if not exists.\e[0m"
+		if [ ! -d $THEME_DIR/MagicMirror ]; then
+			sudo mkdir $THEME_DIR/MagicMirror
+		fi
+
+		if sudo cp ~/MagicMirror/splashscreen/splash.png $THEME_DIR/MagicMirror/splash.png && sudo cp ~/MagicMirror/splashscreen/MagicMirror.plymouth $THEME_DIR/MagicMirror/MagicMirror.plymouth && sudo cp ~/MagicMirror/splashscreen/MagicMirror.script $THEME_DIR/MagicMirror/MagicMirror.script; then
+			echo -e "\e[90mSplashscreen: Theme copied successfully.\e[0m"
+			if sudo plymouth-set-default-theme -R MagicMirror; then
+				echo -e "\e[92mSplashscreen: Changed theme to MagicMirror successfully.\e[0m"
+			else
+				echo -e "\e[91mSplashscreen: Couldn't change theme to MagicMirror!\e[0m"
+			fi
+		else
+			echo -e "\e[91mSplashscreen: Copying theme failed!\e[0m"
+		fi
+	else
+		echo -e "\e[91mSplashscreen: Themes folder doesn't exist!\e[0m"
+	fi
+else
+	echo -e "\e[93mplymouth is not installed.\e[0m";
+fi
+
+# Use pm2 control like a service MagicMirror
+read -p "Do you want use pm2 for auto starting of your MagicMirror (y/N)?" choice
+if [[ $choice =~ ^[Yy]$ ]]; then
+    #
+    #  check if this is a mac
+    #
+    mac=$(uname -s)
+    up=""
+    if [ $mac == 'Darwin' ]; then 
+       up="--unsafe-perm"
+    fi
+    sudo npm install $up -g pm2
+	if [[ "$(ps --no-headers -o comm 1)" =~ systemd ]]; then #Checking for systemd
+		pm2 startup systemd -u $USER --hp /home/$USER
+	else
+		sudo su -c "env PATH=$PATH:/usr/bin pm2 startup linux -u $USER --hp /home/$USER"
+	fi
+  if [ "USER"  != "pi" ]; then 
+		sed 's/pi/'$USER'/g' mm.sh >mm.sh
+    sed 's/pi/'$USER'/g' $PM2_FILE > ~/MagicMirror/installers/pm2_MagicMirror_new.json
+    PM2_FILE=~/MagicMirror/installers/pm2_MagicMirror_new.json
+  fi
+	pm2 start $PM2_FILE 
+	pm2 save
+fi
+# Disable Screensaver
+if [ -d "/etc/xdg/lxsession" ]; then
+	read -p "Do you want to disable the screen saver? (y/N)?" choice
+	if [[ $choice =~ ^[Yy]$ ]]; then
+		sudo su -c "echo -e '@xset s noblank\n@xset s off\n@xset -dpms' >> /etc/xdg/lxsession/LXDE-pi/autostart"
+		export DISPLAY=:0; xset s noblank;xset s off;xset -dpms
+	fi
+else
+	echo " "
+	echo -e "unable to disable screen saver, /etc/xdg/lxsession does not exist"
+fi
+
 echo " "
 echo -e "\e[92mWe're ready! Run \e[1m\e[97mDISPLAY=:0 npm start\e[0m\e[92m from the ~/MagicMirror directory to start your MagicMirror.\e[0m"
 echo " "

js/app.js

@@ -7,9 +7,27 @@
 
 var fs = require("fs");
 var Server = require(__dirname + "/server.js");
+var Utils = require(__dirname + "/utils.js");
 var defaultModules = require(__dirname + "/../modules/default/defaultmodules.js");
 var path = require("path");
 
+// Get version number.
+global.version = JSON.parse(fs.readFileSync("package.json", "utf8")).version;
+console.log("Starting MagicMirror: v" + global.version);
+
+// global absolute root path
+global.root_path = path.resolve(__dirname + "/../");
+
+if (process.env.MM_CONFIG_FILE) {
+	global.configuration_file = process.env.MM_CONFIG_FILE;
+}
+
+// FIXME: Hotfix Pull Request
+// https://github.com/MichMich/MagicMirror/pull/673
+if (process.env.MM_PORT) {
+	global.mmPort = process.env.MM_PORT;
+}
+
 // The next part is here to prevent a major exception when there
 // is no internet connection. This could probable be solved better.
 process.on("uncaughtException", function (err) {
@@ -30,27 +48,52 @@ var App = function() {
 	 *
 	 * argument callback function - The callback function.
 	 */
-
 	var loadConfig = function(callback) {
 		console.log("Loading config ...");
 		var defaults = require(__dirname + "/defaults.js");
-		var configFilename = path.resolve(__dirname + "/../config/config.js");
+
+		// For this check proposed to TestSuite
+		// https://forum.magicmirror.builders/topic/1456/test-suite-for-magicmirror/8
+		var configFilename = path.resolve(global.root_path + "/config/config.js");
+		if (typeof(global.configuration_file) !== "undefined") {
+		    configFilename = path.resolve(global.configuration_file);
+		}
+
 		try {
 			fs.accessSync(configFilename, fs.F_OK);
 			var c = require(configFilename);
+			checkDeprecatedOptions(c);
 			var config = Object.assign(defaults, c);
 			callback(config);
 		} catch (e) {
-			if (e.code == "ENOENT") {
-				console.error("WARNING! Could not find config file. Please create one. Starting with default configuration.");
-				callback(defaults);
+			if (e.code === "ENOENT") {
+				console.error(Utils.colors.error("WARNING! Could not find config file. Please create one. Starting with default configuration."));
 			} else if (e instanceof ReferenceError || e instanceof SyntaxError) {
-				console.error("WARNING! Could not validate config file. Please correct syntax errors. Starting with default configuration.");
-				callback(defaults);
+				console.error(Utils.colors.error("WARNING! Could not validate config file. Starting with default configuration. Please correct syntax errors at or above this line: " + e.stack));
 			} else {
-				console.error("WARNING! Could not load config file. Starting with default configuration. Error found: " + e);
-				callback(defaults);
+				console.error(Utils.colors.error("WARNING! Could not load config file. Starting with default configuration. Error found: " + e));
 			}
+			callback(defaults);
+		}
+	};
+
+	var checkDeprecatedOptions = function(userConfig) {
+		var deprecated = require(global.root_path + "/js/deprecated.js");
+		var deprecatedOptions = deprecated.configs;
+
+		var usedDeprecated = [];
+
+		deprecatedOptions.forEach(function(option) {
+			if (userConfig.hasOwnProperty(option)) {
+				usedDeprecated.push(option);
+			}
+		});
+		if (usedDeprecated.length > 0) {
+			console.warn(Utils.colors.warn(
+				"WARNING! Your config is using deprecated options: " +
+				usedDeprecated.join(", ") +
+				". Check README and CHANGELOG for more up-to-date ways of getting the same functionality.")
+			);
 		}
 	};
 
@@ -59,7 +102,7 @@ var App = function() {
 	 *
 	 * argument module string - The name of the module (including subpath).
 	 */
-	var loadModule = function(module) {
+	var loadModule = function(module, callback) {
 
 		var elements = module.split("/");
 		var moduleName = elements[elements.length - 1];
@@ -82,9 +125,24 @@ var App = function() {
 		if (loadModule) {
 			var Module = require(helperPath);
 			var m = new Module();
+
+			if (m.requiresVersion) {
+				console.log("Check MagicMirror version for node helper '" + moduleName + "' - Minimum version:  " + m.requiresVersion + " - Current version: " + global.version);
+				if (cmpVersions(global.version, m.requiresVersion) >= 0) {
+					console.log("Version is ok!");
+				} else {
+					console.log("Version is incorrect. Skip module: '" + moduleName + "'");
+					return;
+				}
+			}
+
 			m.setName(moduleName);
 			m.setPath(path.resolve(moduleFolder));
 			nodeHelpers.push(m);
+
+			m.loaded(callback);
+		} else {
+			callback();
 		}
 	};
 
@@ -93,20 +151,52 @@ var App = function() {
 	 *
 	 * argument module string - The name of the module (including subpath).
 	 */
-	var loadModules = function(modules) {
+	var loadModules = function(modules, callback) {
 		console.log("Loading module helpers ...");
 
-		for (var m in modules) {
-			loadModule(modules[m]);
-		}
+		var loadNextModule = function() {
+			if (modules.length > 0) {
+				var nextModule = modules[0];
+				loadModule(nextModule, function() {
+					modules = modules.slice(1);
+					loadNextModule();
+				});
+			} else {
+				// All modules are loaded
+				console.log("All module helpers loaded.");
+				callback();
+			}
+		};
 
-		console.log("All module helpers loaded.");
+		loadNextModule();
 	};
 
+	/* cmpVersions(a,b)
+	 * Compare two semantic version numbers and return the difference.
+	 *
+	 * argument a string - Version number a.
+	 * argument a string - Version number b.
+	 */
+	function cmpVersions(a, b) {
+		var i, diff;
+		var regExStrip0 = /(\.0+)+$/;
+		var segmentsA = a.replace(regExStrip0, "").split(".");
+		var segmentsB = b.replace(regExStrip0, "").split(".");
+		var l = Math.min(segmentsA.length, segmentsB.length);
+
+		for (i = 0; i < l; i++) {
+			diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
+			if (diff) {
+				return diff;
+			}
+		}
+		return segmentsA.length - segmentsB.length;
+	}
+
 	/* start(callback)
 	 * This methods starts the core app.
 	 * It loads the config, then it loads all modules.
-	 * When it"s done it executs the callback with the config as argument.
+	 * When it's done it executes the callback with the config as argument.
 	 *
 	 * argument callback function - The callback function.
 	 */
@@ -119,32 +209,67 @@ var App = function() {
 
 			for (var m in config.modules) {
 				var module = config.modules[m];
-				if (modules.indexOf(module.module) === -1) {
+				if (modules.indexOf(module.module) === -1 && !module.disabled) {
 					modules.push(module.module);
 				}
 			}
 
-			loadModules(modules);
+			loadModules(modules, function() {
+				var server = new Server(config, function(app, io) {
+					console.log("Server started ...");
 
-			var server = new Server(config, function(app, io) {
-				console.log("Server started ...");
+					for (var h in nodeHelpers) {
+						var nodeHelper = nodeHelpers[h];
+						nodeHelper.setExpressApp(app);
+						nodeHelper.setSocketIO(io);
+						nodeHelper.start();
+					}
 
-				for (var h in nodeHelpers) {
-					var nodeHelper = nodeHelpers[h];
-					nodeHelper.setExpressApp(app);
-					nodeHelper.setSocketIO(io);
-					nodeHelper.start();
-				}
-
-				console.log("Sockets connected & modules started ...");
-
-				if (typeof callback === "function") {
-					callback(config);
-				}
+					console.log("Sockets connected & modules started ...");
 
+					if (typeof callback === "function") {
+						callback(config);
+					}
+				});
 			});
 		});
 	};
+
+	/* stop()
+	 * This methods stops the core app.
+	 * This calls each node_helper's STOP() function, if it exists.
+	 * Added to fix #1056
+	 */
+	this.stop = function() {
+		for (var h in nodeHelpers) {
+			var nodeHelper = nodeHelpers[h];
+			if (typeof nodeHelper.stop === "function") {
+				nodeHelper.stop();
+			}
+		}
+	};
+
+	/* Listen for SIGINT signal and call stop() function.
+	 *
+	 * Added to fix #1056
+	 * Note: this is only used if running `server-only`. Otherwise
+	 * this.stop() is called by app.on("before-quit"... in `electron.js`
+	 */
+	process.on("SIGINT", () => {
+		console.log("[SIGINT] Received. Shutting down server...");
+		setTimeout(() => { process.exit(0); }, 3000);  // Force quit after 3 seconds
+		this.stop();
+		process.exit(0);
+	});
+
+	/* We also need to listen to SIGTERM signals so we stop everything when we are asked to stop by the OS.
+	 */
+	process.on("SIGTERM", () => {
+		console.log("[SIGTERM] Received. Shutting down server...");
+		setTimeout(() => { process.exit(0); }, 3000);  // Force quit after 3 seconds
+		this.stop();
+		process.exit(0);
+	});
 };
 
-module.exports = new App();
+module.exports = new App();

js/class.js

@@ -4,15 +4,15 @@
  */
 
 // Inspired by base2 and Prototype
-(function() {
+(function () {
 	var initializing = false;
-	var fnTest = /xyz/.test(function() {xyz;}) ? /\b_super\b/ : /.*/;
+	var fnTest = /xyz/.test(function () { xyz; }) ? /\b_super\b/ : /.*/;
 
 	// The base Class implementation (does nothing)
-	this.Class = function() {};
+	this.Class = function () { };
 
 	// Create a new Class that inherits from this class
-	Class.extend = function(prop) {
+	Class.extend = function (prop) {
 		var _super = this.prototype;
 
 		// Instantiate a base class (but only create the instance,
@@ -21,28 +21,31 @@
 		var prototype = new this();
 		initializing = false;
 
+		// Make a copy of all prototype properties, to prevent reference issues.
+		for (var name in prototype) {
+			prototype[name] = cloneObject(prototype[name]);
+		}
+
 		// Copy the properties over onto the new prototype
 		for (var name in prop) {
 			// Check if we're overwriting an existing function
-			prototype[name] = typeof prop[name] == "function" &&
-			typeof _super[name] == "function" && fnTest.test(prop[name]) ?
-        (function(name, fn) {
-	return function() {
-		var tmp = this._super;
+			prototype[name] = typeof prop[name] === "function" &&
+				typeof _super[name] === "function" && fnTest.test(prop[name]) ? (function (name, fn) {
+					return function () {
+						var tmp = this._super;
 
-		// Add a new ._super() method that is the same method
-		// but on the super-class
-		this._super = _super[name];
+						// Add a new ._super() method that is the same method
+						// but on the super-class
+						this._super = _super[name];
 
-		// The method only need to be bound temporarily, so we
-		// remove it when we're done executing
-		var ret = fn.apply(this, arguments);
-		this._super = tmp;
+						// The method only need to be bound temporarily, so we
+						// remove it when we're done executing
+						var ret = fn.apply(this, arguments);
+						this._super = tmp;
 
-		return ret;
-	};
-        })(name, prop[name]) :
-        prop[name];
+						return ret;
+					};
+				})(name, prop[name]) : prop[name];
 		}
 
 		// The dummy class constructor
@@ -66,5 +69,26 @@
 	};
 })();
 
+//Define the clone method for later use.
+//Helper Method
+function cloneObject(obj) {
+	if (obj === null || typeof obj !== "object") {
+		return obj;
+	}
+
+	var temp = obj.constructor(); // give temp the original obj's constructor
+	for (var key in obj) {
+		temp[key] = cloneObject(obj[key]);
+
+		if (key === "lockStrings") {
+			Log.log(key);
+		}
+	}
+
+	return temp;
+}
+
 /*************** DO NOT EDIT THE LINE BELOW ***************/
-if (typeof module !== "undefined") {module.exports = Class;}
+if (typeof module !== "undefined") {
+	module.exports = Class;
+}

js/defaults.js

@@ -7,15 +7,29 @@
  * MIT Licensed.
  */
 
+var port = 8080;
+var address = "localhost";
+if (typeof(mmPort) !== "undefined") {
+	port = mmPort;
+}
 var defaults = {
-	port: 8080,
+	address: address,
+	port: port,
 	kioskmode: false,
+	electronOptions: {},
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
 
 	language: "en",
 	timeFormat: 24,
 	units: "metric",
+	zoom: 1,
+	customCss: "css/custom.css",
 
 	modules: [
+		{
+			module: "updatenotification",
+			position: "top_center"
+		},
 		{
 			module: "helloworld",
 			position: "upper_third",

js/deprecated.js

@@ -0,0 +1,14 @@
+/* Magic Mirror Deprecated Config Options List
+ *
+ * By Michael Teeuw http://michaelteeuw.nl
+ * MIT Licensed.
+ *
+ * Olex S. original idea this deprecated option
+ */
+
+var deprecated = {
+	configs: ["kioskmode"],
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = deprecated;}

js/electron.js

@@ -1,11 +1,12 @@
+/* jshint esversion: 6 */
+
 "use strict";
 
-const Server = require(__dirname + "/server.js");
 const electron = require("electron");
 const core = require(__dirname + "/app.js");
 
 // Config
-var config = {};
+var config = process.env.config ? JSON.parse(process.env.config) : {};
 // Module to control application life.
 const app = electron.app;
 // Module to create native browser window.
@@ -16,29 +17,64 @@ const BrowserWindow = electron.BrowserWindow;
 let mainWindow;
 
 function createWindow() {
-	// Create the browser window.
+	app.commandLine.appendSwitch("autoplay-policy", "no-user-gesture-required");
+	var electronOptionsDefaults = {
+		width: 800,
+		height: 600,
+		x: 0,
+		y: 0,
+		darkTheme: true,
+		webPreferences: {
+			nodeIntegration: false,
+			zoomFactor: config.zoom
+		},
+		backgroundColor: "#000000"
+	};
+
+	// DEPRECATED: "kioskmode" backwards compatibility, to be removed
+	// settings these options directly instead provides cleaner interface
 	if (config.kioskmode) {
-		mainWindow = new BrowserWindow({width: 800, height: 600, x: 0, y: 0, kiosk:true, darkTheme: true, webPreferences: {nodeIntegration: false}});
+		electronOptionsDefaults.kiosk = true;
 	} else {
-		mainWindow = new BrowserWindow({width: 800, height: 600, x: 0, y: 0, fullscreen: true, autoHideMenuBar: true, darkTheme: true, webPreferences: {nodeIntegration: false}});
+		electronOptionsDefaults.fullscreen = true;
+		electronOptionsDefaults.autoHideMenuBar = true;
 	}
 
+	var electronOptions = Object.assign({}, electronOptionsDefaults, config.electronOptions);
+
+	// Create the browser window.
+	mainWindow = new BrowserWindow(electronOptions);
+
 	// and load the index.html of the app.
-	//mainWindow.loadURL('file://' + __dirname + '../../index.html');
-	mainWindow.loadURL("http://localhost:" + config.port);
+	// If config.address is not defined or is an empty string (listening on all interfaces), connect to localhost
+	var address = (config.address === void 0) | (config.address === "") ? (config.address = "localhost") : config.address;
+	mainWindow.loadURL(`http://${address}:${config.port}`);
 
 	// Open the DevTools if run with "npm start dev"
-	if(process.argv[2] == "dev"){
+	if (process.argv.includes("dev")) {
 		mainWindow.webContents.openDevTools();
 	}
 
-	// Emitted when the window is closed.
+	// Set responders for window events.
 	mainWindow.on("closed", function() {
-		// Dereference the window object, usually you would store windows
-		// in an array if your app supports multi windows, this is the time
-		// when you should delete the corresponding element.
 		mainWindow = null;
 	});
+
+	if (config.kioskmode) {
+		mainWindow.on("blur", function() {
+			mainWindow.focus();
+		});
+
+		mainWindow.on("leave-full-screen", function() {
+			mainWindow.setFullScreen(true);
+		});
+
+		mainWindow.on("resize", function() {
+			setTimeout(function() {
+				mainWindow.reload();
+			}, 1000);
+		});
+	}
 }
 
 // This method will be called when Electron has finished
@@ -50,11 +86,7 @@ app.on("ready", function() {
 
 // Quit when all windows are closed.
 app.on("window-all-closed", function() {
-	// On OS X it is common for applications and their menu bar
-	// to stay active until the user quits explicitly with Cmd + Q
-	if (process.platform !== "darwin") {
-		app.quit();
-	}
+	createWindow();
 });
 
 app.on("activate", function() {
@@ -65,8 +97,24 @@ app.on("activate", function() {
 	}
 });
 
-// Start the core application.
-// This starts all node helpers and starts the webserver.
-core.start(function(c) {
-	config = c;
+/* This method will be called when SIGINT is received and will call
+ * each node_helper's stop function if it exists. Added to fix #1056
+ *
+ * Note: this is only used if running Electron. Otherwise
+ * core.stop() is called by process.on("SIGINT"... in `app.js`
+ */
+app.on("before-quit", (event) => {
+	console.log("Shutting down server...");
+	event.preventDefault();
+	setTimeout(() => { process.exit(0); }, 3000); // Force-quit after 3 seconds.
+	core.stop();
+	process.exit(0);
 });
+
+// Start the core application if server is run on localhost
+// This starts all node helpers and starts the webserver.
+if (["localhost", "127.0.0.1", "::1", "::ffff:127.0.0.1", undefined].indexOf(config.address) > -1) {
+	core.start(function(c) {
+		config = c;
+	});
+}

js/loader.js

@@ -8,7 +8,7 @@
 
 var Loader = (function() {
 
-	/* Create helper valiables */
+	/* Create helper variables */
 
 	var loadedModuleFiles = [];
 	var loadedFiles = [];
@@ -32,10 +32,10 @@ var Loader = (function() {
 				});
 			} else {
 				// All modules loaded. Load custom.css
-				// This is done after all the moduels so we can
-				// overwrite all the defined styls.
+				// This is done after all the modules so we can
+				// overwrite all the defined styles.
 
-				loadFile("css/custom.css", function() {
+				loadFile(config.customCss, function() {
 					// custom.css loaded. Start all modules.
 					startModules();
 				});
@@ -55,7 +55,7 @@ var Loader = (function() {
 			module.start();
 		}
 
-		// Notifiy core of loded modules.
+		// Notify core of loaded modules.
 		MM.modulesStarted(moduleObjects);
 	};
 
@@ -89,6 +89,10 @@ var Loader = (function() {
 				moduleFolder =  config.paths.modules + "/default/" + module;
 			}
 
+			if (moduleData.disabled === true) {
+				continue;
+			}
+
 			moduleFiles.push({
 				index: m,
 				identifier: "module_" + m + "_" + module,
@@ -100,7 +104,6 @@ var Loader = (function() {
 				config: moduleData.config,
 				classes: (typeof moduleData.classes !== "undefined") ? moduleData.classes + " " + module : module
 			});
-
 		}
 
 		return moduleFiles;
@@ -117,9 +120,13 @@ var Loader = (function() {
 
 		var afterLoad = function() {
 			var moduleObject = Module.create(module.name);
-			bootstrapModule(module, moduleObject, function() {
+			if (moduleObject) {
+				bootstrapModule(module, moduleObject, function() {
+					callback();
+				});
+			} else {
 				callback();
-			});
+			}
 		};
 
 		if (loadedModuleFiles.indexOf(url) !== -1) {
@@ -130,7 +137,6 @@ var Loader = (function() {
 				afterLoad();
 			});
 		}
-
 	};
 
 	/* bootstrapModule(module, mObj)
@@ -156,7 +162,6 @@ var Loader = (function() {
 				});
 			});
 		});
-
 	};
 
 	/* loadFile(fileName)
@@ -178,6 +183,11 @@ var Loader = (function() {
 			script.onload = function() {
 				if (typeof callback === "function") {callback();}
 			};
+			script.onerror = function() {
+				console.error("Error on loading script:", fileName);
+				if (typeof callback === "function") {callback();}
+			};
+
 			document.getElementsByTagName("body")[0].appendChild(script);
 			break;
 		case "css":
@@ -189,10 +199,14 @@ var Loader = (function() {
 			stylesheet.onload = function() {
 				if (typeof callback === "function") {callback();}
 			};
+			stylesheet.onerror = function() {
+				console.error("Error on loading stylesheet:", fileName);
+				if (typeof callback === "function") {callback();}
+			};
+
 			document.getElementsByTagName("head")[0].appendChild(stylesheet);
 			break;
 		}
-
 	};
 
 	/* Public Methods */
@@ -243,5 +257,4 @@ var Loader = (function() {
 			loadFile(module.file(fileName), callback);
 		}
 	};
-
 })();

js/logger.js

@@ -13,35 +13,15 @@
 
 var Log = (function() {
 	return {
-		info: function(message) {
-			console.info(message);
-		},
-		log: function(message) {
-			console.log(message);
-		},
-		error: function(message) {
-			console.error(message);
-		},
-		warn: function(message) {
-			console.warn(message);	
-		},
-		group: function(message) {
-			console.group(message);	
-		},
-		groupCollapsed: function(message) {
-			console.groupCollapsed(message);
-		},
-		groupEnd: function() {
-			console.groupEnd();
-		},
-		time: function(message) {
-			console.time(message);
-		},
-		timeEnd: function(message) {
-			console.timeEnd(message);
-		},
-		timeStamp: function(message) {
-			console.timeStamp(message);
-		}
+		info: Function.prototype.bind.call(console.info, console),
+		log:  Function.prototype.bind.call(console.log, console),
+		error: Function.prototype.bind.call(console.error, console),
+		warn: Function.prototype.bind.call(console.warn, console),
+		group: Function.prototype.bind.call(console.group, console),
+		groupCollapsed: Function.prototype.bind.call(console.groupCollapsed, console),
+		groupEnd: Function.prototype.bind.call(console.groupEnd, console),
+		time: Function.prototype.bind.call(console.time, console),
+		timeEnd: Function.prototype.bind.call(console.timeEnd, console),
+		timeStamp: Function.prototype.bind.call(console.timeStamp, console)
 	};
 })();

js/main.js

@@ -1,5 +1,5 @@
 /* global  Log, Loader, Module, config, defaults */
-/* jshint -W020 */
+/* jshint -W020, esversion: 6 */
 
 /* Magic Mirror
  * Main System
@@ -19,39 +19,49 @@ var MM = (function() {
 	 * are configured for a specific position.
 	 */
 	var createDomObjects = function() {
-		for (var m in modules) {
-			var module = modules[m];
+		var domCreationPromises = [];
 
-			if (typeof module.data.position === "string") {
-
-				var wrapper = selectWrapper(module.data.position);
-
-				var dom = document.createElement("div");
-				dom.id = module.identifier;
-				dom.className = module.name;
-
-				if (typeof module.data.classes === "string") {
-					dom.className = "module " + dom.className + " " + module.data.classes;
-				}
-
-				dom.opacity = 0;
-				wrapper.appendChild(dom);
-
-				if (typeof module.data.header !== "undefined" && module.data.header !== "") {
-					var moduleHeader = document.createElement("header");
-					moduleHeader.innerHTML = module.data.header;
-					dom.appendChild(moduleHeader);
-				}
-
-				var moduleContent = document.createElement("div");
-				moduleContent.className = "module-content";
-				dom.appendChild(moduleContent);
-
-				updateDom(module, 0);
+		modules.forEach(function(module) {
+			if (typeof module.data.position !== "string") {
+				return;
 			}
-		}
 
-		sendNotification("DOM_OBJECTS_CREATED");
+			var wrapper = selectWrapper(module.data.position);
+
+			var dom = document.createElement("div");
+			dom.id = module.identifier;
+			dom.className = module.name;
+
+			if (typeof module.data.classes === "string") {
+				dom.className = "module " + dom.className + " " + module.data.classes;
+			}
+
+			dom.opacity = 0;
+			wrapper.appendChild(dom);
+
+			if (typeof module.getHeader() !== "undefined" && module.getHeader() !== "") {
+				var moduleHeader = document.createElement("header");
+				moduleHeader.innerHTML = module.getHeader();
+				moduleHeader.className = "module-header";
+				dom.appendChild(moduleHeader);
+			}
+
+			var moduleContent = document.createElement("div");
+			moduleContent.className = "module-content";
+			dom.appendChild(moduleContent);
+
+			var domCreationPromise = updateDom(module, 0);
+			domCreationPromises.push(domCreationPromise);
+			domCreationPromise.then(function() {
+				sendNotification("MODULE_DOM_CREATED", null, null, module);
+			}).catch(Log.error);
+		});
+
+		updateWrapperStates();
+
+		Promise.all(domCreationPromises).then(function() {
+			sendNotification("DOM_OBJECTS_CREATED");
+		});
 	};
 
 	/* selectWrapper(position)
@@ -63,7 +73,7 @@ var MM = (function() {
 		var classes = position.replace("_"," ");
 		var parentWrapper = document.getElementsByClassName(classes);
 		if (parentWrapper.length > 0) {
-			var wrapper =  parentWrapper[0].getElementsByClassName("container");
+			var wrapper = parentWrapper[0].getElementsByClassName("container");
 			if (wrapper.length > 0) {
 				return wrapper[0];
 			}
@@ -73,14 +83,15 @@ var MM = (function() {
 	/* sendNotification(notification, payload, sender)
 	 * Send a notification to all modules.
 	 *
-	 * argument notification string - The identifier of the noitication.
+	 * argument notification string - The identifier of the notification.
 	 * argument payload mixed - The payload of the notification.
 	 * argument sender Module - The module that sent the notification.
+	 * argument sendTo Module - The module to send the notification to. (optional)
 	 */
-	var sendNotification = function(notification, payload, sender) {
+	var sendNotification = function(notification, payload, sender, sendTo) {
 		for (var m in modules) {
 			var module = modules[m];
-			if (module !== sender) {
+			if (module !== sender && (!sendTo || module === sendTo)) {
 				module.notificationReceived(notification, payload, sender);
 			}
 		}
@@ -91,62 +102,117 @@ var MM = (function() {
 	 *
 	 * argument module Module - The module that needs an update.
 	 * argument speed Number - The number of microseconds for the animation. (optional)
+	 *
+	 * return Promise - Resolved when the dom is fully updated.
 	 */
 	var updateDom = function(module, speed) {
-		var newContent = module.getDom();
+		return new Promise(function(resolve) {
+			var newContentPromise = module.getDom();
+			var newHeader = module.getHeader();
 
-		if (!module.hidden) {
+			if (!(newContentPromise instanceof Promise)) {
+				// convert to a promise if not already one to avoid if/else's everywhere
+				newContentPromise = Promise.resolve(newContentPromise);
+			}
 
-			if (!moduleNeedsUpdate(module, newContent)) {
+			newContentPromise.then(function(newContent) {
+				var updatePromise = updateDomWithContent(module, speed, newHeader, newContent);
+
+				updatePromise.then(resolve).catch(Log.error);
+			}).catch(Log.error);
+		});
+	};
+
+	/* updateDomWithContent(module, speed, newHeader, newContent)
+	 * Update the dom with the specified content
+	 *
+	 * argument module Module - The module that needs an update.
+	 * argument speed Number - The number of microseconds for the animation. (optional)
+	 * argument newHeader String - The new header that is generated.
+	 * argument newContent Domobject - The new content that is generated.
+	 *
+	 * return Promise - Resolved when the module dom has been updated.
+	 */
+	var updateDomWithContent = function(module, speed, newHeader, newContent) {
+		return new Promise(function(resolve) {
+			if (module.hidden || !speed) {
+				updateModuleContent(module, newHeader, newContent);
+				resolve();
+				return;
+			}
+
+			if (!moduleNeedsUpdate(module, newHeader, newContent)) {
+				resolve();
 				return;
 			}
 
 			if (!speed) {
-				updateModuleContent(module, newContent);
+				updateModuleContent(module, newHeader, newContent);
+				resolve();
 				return;
 			}
 
 			hideModule(module, speed / 2, function() {
-				updateModuleContent(module, newContent);
+				updateModuleContent(module, newHeader, newContent);
 				if (!module.hidden) {
 					showModule(module, speed / 2);
 				}
+				resolve();
 			});
-		} else {
-			updateModuleContent(module, newContent);
-		}
+		});
 	};
 
 	/* moduleNeedsUpdate(module, newContent)
 	 * Check if the content has changed.
 	 *
 	 * argument module Module - The module to check.
+	 * argument newHeader String - The new header that is generated.
 	 * argument newContent Domobject - The new content that is generated.
 	 *
 	 * return bool - Does the module need an update?
 	 */
-	var moduleNeedsUpdate = function(module, newContent) {
+	var moduleNeedsUpdate = function(module, newHeader, newContent) {
 		var moduleWrapper = document.getElementById(module.identifier);
-		var contentWrapper = moduleWrapper.getElementsByClassName("module-content")[0];
+		if (moduleWrapper === null) {
+			return false;
+		}
 
-		var tempWrapper = document.createElement("div");
-		tempWrapper.appendChild(newContent);
+		var contentWrapper = moduleWrapper.getElementsByClassName("module-content");
+		var headerWrapper = moduleWrapper.getElementsByClassName("module-header");
 
-		return tempWrapper.innerHTML !== contentWrapper.innerHTML;
+		var headerNeedsUpdate = false;
+		var contentNeedsUpdate = false;
+
+		if (headerWrapper.length > 0) {
+			headerNeedsUpdate = newHeader !== headerWrapper[0].innerHTML;
+		}
+
+		var tempContentWrapper = document.createElement("div");
+		tempContentWrapper.appendChild(newContent);
+		contentNeedsUpdate = tempContentWrapper.innerHTML !== contentWrapper[0].innerHTML;
+
+		return headerNeedsUpdate || contentNeedsUpdate;
 	};
 
 	/* moduleNeedsUpdate(module, newContent)
 	 * Update the content of a module on screen.
 	 *
 	 * argument module Module - The module to check.
+	 * argument newHeader String - The new header that is generated.
 	 * argument newContent Domobject - The new content that is generated.
 	 */
-	var updateModuleContent = function(module, content) {
+	var updateModuleContent = function(module, newHeader, newContent) {
 		var moduleWrapper = document.getElementById(module.identifier);
-		var contentWrapper = moduleWrapper.getElementsByClassName("module-content")[0];
+		if (moduleWrapper === null) {return;}
+		var headerWrapper = moduleWrapper.getElementsByClassName("module-header");
+		var contentWrapper = moduleWrapper.getElementsByClassName("module-content");
 
-		contentWrapper.innerHTML = "";
-		contentWrapper.appendChild(content);
+		contentWrapper[0].innerHTML = "";
+		contentWrapper[0].appendChild(newContent);
+
+		if( headerWrapper.length > 0 && newHeader) {
+			headerWrapper[0].innerHTML = newHeader;
+		}
 	};
 
 	/* hideModule(module, speed, callback)
@@ -156,7 +222,17 @@ var MM = (function() {
 	 * argument speed Number - The speed of the hide animation.
 	 * argument callback function - Called when the animation is done.
 	 */
-	var hideModule = function(module, speed, callback) {
+	var hideModule = function(module, speed, callback, options) {
+		options = options || {};
+
+		// set lockString if set in options.
+		if (options.lockString) {
+			// Log.log("Has lockstring: " + options.lockString);
+			if (module.lockStrings.indexOf(options.lockString) === -1) {
+				module.lockStrings.push(options.lockString);
+			}
+		}
+
 		var moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
@@ -165,13 +241,18 @@ var MM = (function() {
 			clearTimeout(module.showHideTimer);
 			module.showHideTimer = setTimeout(function() {
 				// To not take up any space, we just make the position absolute.
-				// since it"s fade out anyway, we can see it lay above or
+				// since it's fade out anyway, we can see it lay above or
 				// below other modules. This works way better than adjusting
 				// the .display property.
-				moduleWrapper.style.position = "absolute";
+				moduleWrapper.style.position = "fixed";
+
+				updateWrapperStates();
 
 				if (typeof callback === "function") { callback(); }
 			}, speed);
+		} else {
+			// invoke callback even if no content, issue 1308
+			if (typeof callback === "function") { callback(); }
 		}
 	};
 
@@ -182,12 +263,42 @@ var MM = (function() {
 	 * argument speed Number - The speed of the show animation.
 	 * argument callback function - Called when the animation is done.
 	 */
-	var showModule = function(module, speed, callback) {
+	var showModule = function(module, speed, callback, options) {
+		options = options || {};
+
+		// remove lockString if set in options.
+		if (options.lockString) {
+			var index = module.lockStrings.indexOf(options.lockString);
+			if ( index !== -1) {
+				module.lockStrings.splice(index, 1);
+			}
+		}
+
+		// Check if there are no more lockstrings set, or the force option is set.
+		// Otherwise cancel show action.
+		if (module.lockStrings.length !== 0 && options.force !== true) {
+			Log.log("Will not show " + module.name + ". LockStrings active: " + module.lockStrings.join(","));
+			return;
+		}
+
+		module.hidden = false;
+
+		// If forced show, clean current lockstrings.
+		if (module.lockStrings.length !== 0 && options.force === true) {
+			Log.log("Force show of module: " + module.name);
+			module.lockStrings = [];
+		}
+
 		var moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
-			// Restore the postition. See hideModule() for more info.
+			// Restore the position. See hideModule() for more info.
 			moduleWrapper.style.position = "static";
+
+			updateWrapperStates();
+
+			// Waiting for DOM-changes done in updateWrapperStates before we can start the animation.
+			var dummy = moduleWrapper.parentElement.parentElement.offsetHeight;
 			moduleWrapper.style.opacity = 1;
 
 			clearTimeout(module.showHideTimer);
@@ -198,6 +309,35 @@ var MM = (function() {
 		}
 	};
 
+	/* updateWrapperStates()
+	 * Checks for all positions if it has visible content.
+	 * If not, if will hide the position to prevent unwanted margins.
+	 * This method should be called by the show and hide methods.
+	 *
+	 * Example:
+	 * If the top_bar only contains the update notification. And no update is available,
+	 * the update notification is hidden. The top bar still occupies space making for
+	 * an ugly top margin. By using this function, the top bar will be hidden if the
+	 * update notification is not visible.
+	 */
+	var updateWrapperStates = function() {
+		var positions = ["top_bar", "top_left", "top_center", "top_right", "upper_third", "middle_center", "lower_third", "bottom_left", "bottom_center", "bottom_right", "bottom_bar", "fullscreen_above", "fullscreen_below"];
+
+		positions.forEach(function(position) {
+			var wrapper = selectWrapper(position);
+			var moduleWrappers = wrapper.getElementsByClassName("module");
+
+			var showWrapper = false;
+			Array.prototype.forEach.call(moduleWrappers, function(moduleWrapper) {
+				if (moduleWrapper.style.position === "" || moduleWrapper.style.position === "static") {
+					showWrapper = true;
+				}
+			});
+
+			wrapper.style.display = showWrapper ? "block" : "none";
+		});
+	};
+
 	/* loadConfig()
 	 * Loads the core config and combines it with de system defaults.
 	 */
@@ -208,7 +348,7 @@ var MM = (function() {
 			return;
 		}
 
-		config = Object.assign(defaults, config);
+		config = Object.assign({}, defaults, config);
 	};
 
 	/* setSelectionMethodsForModules()
@@ -219,43 +359,36 @@ var MM = (function() {
 	var setSelectionMethodsForModules = function(modules) {
 
 		/* withClass(className)
-		 * filters a collection of modules based on classname(s).
+		 * calls modulesByClass to filter modules with the specified classes.
 		 *
-		 * argument className string/array - one or multiple classnames. (array or space devided)
+		 * argument className string/array - one or multiple classnames. (array or space divided)
 		 *
 		 * return array - Filtered collection of modules.
 		 */
 		var withClass = function(className) {
-			var searchClasses = className;
-			if (typeof className === "string") {
-				searchClasses = className.split(" ");
-			}
-
-			var newModules = modules.filter(function(module) {
-				var classes = module.data.classes.toLowerCase().split(" ");
-
-				for (var c in searchClasses) {
-					var searchClass = searchClasses[c];
-					if (classes.indexOf(searchClass.toLowerCase()) !== -1) {
-						return true;
-					}
-				}
-
-				return false;
-			});
-
-			setSelectionMethodsForModules(newModules);
-			return newModules;
+			return modulesByClass(className, true);
 		};
 
 		/* exceptWithClass(className)
-		 * filters a collection of modules based on classname(s). (NOT)
+		 * calls modulesByClass to filter modules without the specified classes.
 		 *
-		 * argument className string/array - one or multiple classnames. (array or space devided)
+		 * argument className string/array - one or multiple classnames. (array or space divided)
 		 *
 		 * return array - Filtered collection of modules.
 		 */
 		var exceptWithClass  = function(className) {
+			return modulesByClass(className, false);
+		};
+
+		/* modulesByClass(className, include)
+		 * filters a collection of modules based on classname(s).
+		 *
+		 * argument className string/array - one or multiple classnames. (array or space divided)
+		 * argument include boolean - if the filter should include or exclude the modules with the specific classes.
+		 *
+		 * return array - Filtered collection of modules.
+		 */
+		var modulesByClass = function(className, include) {
 			var searchClasses = className;
 			if (typeof className === "string") {
 				searchClasses = className.split(" ");
@@ -267,11 +400,11 @@ var MM = (function() {
 				for (var c in searchClasses) {
 					var searchClass = searchClasses[c];
 					if (classes.indexOf(searchClass.toLowerCase()) !== -1) {
-						return false;
+						return include;
 					}
 				}
 
-				return true;
+				return !include;
 			});
 
 			setSelectionMethodsForModules(newModules);
@@ -345,7 +478,7 @@ var MM = (function() {
 		/* sendNotification(notification, payload, sender)
 		 * Send a notification to all modules.
 		 *
-		 * argument notification string - The identifier of the noitication.
+		 * argument notification string - The identifier of the notification.
 		 * argument payload mixed - The payload of the notification.
 		 * argument sender Module - The module that sent the notification.
 		 */
@@ -401,10 +534,11 @@ var MM = (function() {
 		 * argument module Module - The module hide.
 		 * argument speed Number - The speed of the hide animation.
 		 * argument callback function - Called when the animation is done.
+		 * argument options object - Optional settings for the hide method.
 		 */
-		hideModule: function(module, speed, callback) {
+		hideModule: function(module, speed, callback, options) {
 			module.hidden = true;
-			hideModule(module, speed, callback);
+			hideModule(module, speed, callback, options);
 		},
 
 		/* showModule(module, speed, callback)
@@ -413,17 +547,18 @@ var MM = (function() {
 		 * argument module Module - The module show.
 		 * argument speed Number - The speed of the show animation.
 		 * argument callback function - Called when the animation is done.
+		 * argument options object - Optional settings for the hide method.
 		 */
-		showModule: function(module, speed, callback) {
-			module.hidden = false;
-			showModule(module, speed, callback);
+		showModule: function(module, speed, callback, options) {
+			// do not change module.hidden yet, only if we really show it later
+			showModule(module, speed, callback, options);
 		}
 	};
 
 })();
 
 // Add polyfill for Object.assign.
-if (typeof Object.assign != "function") {
+if (typeof Object.assign !== "function") {
 	(function() {
 		Object.assign = function(target) {
 			"use strict";

js/module.js

@@ -14,23 +14,35 @@ var Module = Class.extend({
 	 * All methods (and properties) below can be subclassed. *
 	 *********************************************************/
 
+	// Set the minimum MagicMirror module version for this module.
+	requiresVersion: "2.0.0",
+
 	// Module config defaults.
 	defaults: {},
 
 	// Timer reference used for showHide animation callbacks.
 	showHideTimer: null,
 
+	// Array to store lockStrings. These strings are used to lock
+	// visibility when hiding and showing module.
+	lockStrings: [],
+
+	// Storage of the nunjuck Environment,
+	// This should not be referenced directly.
+	// Use the nunjucksEnvironment() to get it.
+	_nunjucksEnvironment: null,
+
 	/* init()
 	 * Is called when the module is instantiated.
 	 */
-	init: function() {
+	init: function () {
 		//Log.log(this.defaults);
 	},
 
 	/* start()
 	 * Is called when the module is started.
 	 */
-	start: function() {
+	start: function () {
 		Log.info("Starting module: " + this.name);
 	},
 
@@ -39,7 +51,7 @@ var Module = Class.extend({
 	 *
 	 * return Array<String> - An array with filenames.
 	 */
-	getScripts: function() {
+	getScripts: function () {
 		return [];
 	},
 
@@ -48,7 +60,7 @@ var Module = Class.extend({
 	 *
 	 * return Array<String> - An array with filenames.
 	 */
-	getStyles: function() {
+	getStyles: function () {
 		return [];
 	},
 
@@ -57,42 +69,87 @@ var Module = Class.extend({
 	 *
 	 * return Map<String, String> - A map with langKeys and filenames.
 	 */
-	getTranslations: function() {
+	getTranslations: function () {
 		return false;
 	},
 
 	/* getDom()
 	 * This method generates the dom which needs to be displayed. This method is called by the Magic Mirror core.
-	 * This method needs to be subclassed if the module wants to display info on the mirror.
+	 * This method can to be subclassed if the module wants to display info on the mirror.
+	 * Alternatively, the getTemplate method could be subclassed.
 	 *
-	 * return domobject - The dom to display.
+	 * return DomObject | Promise - The dom or a promise with the dom to display.
 	 */
-	getDom: function() {
-		var nameWrapper = document.createElement("div");
-		var name = document.createTextNode(this.name);
-		nameWrapper.appendChild(name);
+	getDom: function () {
+		var self = this;
+		return new Promise(function(resolve) {
+			var div = document.createElement("div");
+			var template = self.getTemplate();
+			var templateData = self.getTemplateData();
 
-		var identifierWrapper = document.createElement("div");
-		var identifier = document.createTextNode(this.identifier);
-		identifierWrapper.appendChild(identifier);
-		identifierWrapper.className = "small dimmed";
+			// Check to see if we need to render a template string or a file.
+			if (/^.*((\.html)|(\.njk))$/.test(template)) {
+				// the template is a filename
+				self.nunjucksEnvironment().render(template, templateData, function (err, res) {
+					if (err) {
+						Log.error(err);
+					}
 
-		var div = document.createElement("div");
-		div.appendChild(nameWrapper);
-		div.appendChild(identifierWrapper);
+					div.innerHTML = res;
 
-		return div;
+					resolve(div);
+				});
+			} else {
+				// the template is a template string.
+				div.innerHTML = self.nunjucksEnvironment().renderString(template, templateData);
+
+				resolve(div);
+			}
+		});
+	},
+
+	/* getHeader()
+	 * This method generates the header string which needs to be displayed if a user has a header configured for this module.
+	 * This method is called by the Magic Mirror core, but only if the user has configured a default header for the module.
+	 * This method needs to be subclassed if the module wants to display modified headers on the mirror.
+	 *
+	 * return string - The header to display above the header.
+	 */
+	getHeader: function () {
+		return this.data.header;
+	},
+
+	/* getTemplate()
+	 * This method returns the template for the module which is used by the default getDom implementation.
+	 * This method needs to be subclassed if the module wants to use a template.
+	 * It can either return a template sting, or a template filename.
+	 * If the string ends with '.html' it's considered a file from within the module's folder.
+	 *
+	 * return string - The template string of filename.
+	 */
+	getTemplate: function () {
+		return "<div class=\"normal\">" + this.name + "</div><div class=\"small dimmed\">" + this.identifier + "</div>";
+	},
+
+	/* getTemplateData()
+	 * This method returns the data to be used in the template.
+	 * This method needs to be subclassed if the module wants to use a custom data.
+	 *
+	 * return Object
+	 */
+	getTemplateData: function () {
+		return {};
 	},
 
 	/* notificationReceived(notification, payload, sender)
 	 * This method is called when a notification arrives.
 	 * This method is called by the Magic Mirror core.
 	 *
-	 * argument notification string - The identifier of the noitication.
+	 * argument notification string - The identifier of the notification.
 	 * argument payload mixed - The payload of the notification.
 	 * argument sender Module - The module that sent the notification.
 	 */
-	notificationReceived: function(notification, payload, sender) {
+	notificationReceived: function (notification, payload, sender) {
 		if (sender) {
 			Log.log(this.name + " received a module notification: " + notification + " from sender: " + sender.name);
 		} else {
@@ -100,27 +157,51 @@ var Module = Class.extend({
 		}
 	},
 
+	/** nunjucksEnvironment()
+	 * Returns the nunjucks environment for the current module.
+	 * The environment is checked in the _nunjucksEnvironment instance variable.
+
+	 * @returns Nunjucks Environment
+	 */
+	nunjucksEnvironment: function() {
+		if (this._nunjucksEnvironment !== null) {
+			return this._nunjucksEnvironment;
+		}
+
+		var self = this;
+
+		this._nunjucksEnvironment = new nunjucks.Environment(new nunjucks.WebLoader(this.file(""), {async: true}), {
+			trimBlocks: true,
+			lstripBlocks: true
+		});
+		this._nunjucksEnvironment.addFilter("translate", function(str) {
+			return self.translate(str);
+		});
+
+		return this._nunjucksEnvironment;
+	},
+
 	/* socketNotificationReceived(notification, payload)
 	 * This method is called when a socket notification arrives.
 	 *
-	 * argument notification string - The identifier of the noitication.
+	 * argument notification string - The identifier of the notification.
 	 * argument payload mixed - The payload of the notification.
 	 */
-	socketNotificationReceived: function(notification, payload) {
+	socketNotificationReceived: function (notification, payload) {
 		Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
 	},
 
 	/* suspend()
 	 * This method is called when a module is hidden.
 	 */
-	suspend: function() {
+	suspend: function () {
 		Log.log(this.name + " is suspended.");
 	},
 
 	/* resume()
 	 * This method is called when a module is shown.
 	 */
-	resume: function() {
+	resume: function () {
 		Log.log(this.name + " is resumed.");
 	},
 
@@ -131,9 +212,9 @@ var Module = Class.extend({
 	/* setData(data)
 	 * Set the module data.
 	 *
-	 * argument data obejct - Module data.
+	 * argument data object - Module data.
 	 */
-	setData: function(data) {
+	setData: function (data) {
 		this.data = data;
 		this.name = data.name;
 		this.identifier = data.identifier;
@@ -145,23 +226,23 @@ var Module = Class.extend({
 	/* setConfig(config)
 	 * Set the module config and combine it with the module defaults.
 	 *
-	 * argument config obejct - Module config.
+	 * argument config object - Module config.
 	 */
-	setConfig: function(config) {
-		this.config = Object.assign(this.defaults, config);
+	setConfig: function (config) {
+		this.config = Object.assign({}, this.defaults, config);
 	},
 
 	/* socket()
-	 * Returns a socket object. If it doesn"t exist, it"s created.
+	 * Returns a socket object. If it doesn't exist, it"s created.
 	 * It also registers the notification callback.
 	 */
-	socket: function() {
+	socket: function () {
 		if (typeof this._socket === "undefined") {
 			this._socket = this._socket = new MMSocket(this.name);
 		}
 
 		var self = this;
-		this._socket.setNotificationCallback(function(notification, payload) {
+		this._socket.setNotificationCallback(function (notification, payload) {
 			self.socketNotificationReceived(notification, payload);
 		});
 
@@ -175,8 +256,8 @@ var Module = Class.extend({
 	 *
 	 * return string - File path.
 	 */
-	file: function(file) {
-		return this.data.path + "/" + file;
+	file: function (file) {
+		return (this.data.path + "/" + file).replace("//", "/");
 	},
 
 	/* loadStyles()
@@ -184,23 +265,8 @@ var Module = Class.extend({
 	 *
 	 * argument callback function - Function called when done.
 	 */
-	loadStyles: function(callback) {
-		var self = this;
-		var styles = this.getStyles();
-
-		var loadNextStyle = function() {
-			if (styles.length > 0) {
-				var nextStyle = styles[0];
-				Loader.loadFile(nextStyle, self, function() {
-					styles = styles.slice(1);
-					loadNextStyle();
-				});
-			} else {
-				callback();
-			}
-		};
-
-		loadNextStyle();
+	loadStyles: function (callback) {
+		this.loadDependencies("getStyles", callback);
 	},
 
 	/* loadScripts()
@@ -208,23 +274,33 @@ var Module = Class.extend({
 	 *
 	 * argument callback function - Function called when done.
 	 */
-	loadScripts: function(callback) {
-		var self = this;
-		var scripts = this.getScripts();
+	loadScripts: function (callback) {
+		this.loadDependencies("getScripts", callback);
+	},
 
-		var loadNextScript = function() {
-			if (scripts.length > 0) {
-				var nextScript = scripts[0];
-				Loader.loadFile(nextScript, self, function() {
-					scripts = scripts.slice(1);
-					loadNextScript();
+	/* loadDependencies(funcName, callback)
+	 * Helper method to load all dependencies.
+	 *
+	 * argument funcName string - Function name to call to get scripts or styles.
+	 * argument callback function - Function called when done.
+	 */
+	loadDependencies: function (funcName, callback) {
+		var self = this;
+		var dependencies = this[funcName]();
+
+		var loadNextDependency = function () {
+			if (dependencies.length > 0) {
+				var nextDependency = dependencies[0];
+				Loader.loadFile(nextDependency, self, function () {
+					dependencies = dependencies.slice(1);
+					loadNextDependency();
 				});
 			} else {
 				callback();
 			}
 		};
 
-		loadNextScript();
+		loadNextDependency();
 	},
 
 	/* loadScripts()
@@ -232,14 +308,14 @@ var Module = Class.extend({
 	 *
 	 * argument callback function - Function called when done.
 	 */
-	loadTranslations: function(callback) {
+	loadTranslations: function (callback) {
 		var self = this;
 		var translations = this.getTranslations();
 		var lang = config.language.toLowerCase();
 
 		// The variable `first` will contain the first
 		// defined translation after the following line.
-		for (var first in translations) {break;}
+		for (var first in translations) { break; }
 
 		if (translations) {
 			var translationFile = translations[lang] || undefined;
@@ -248,7 +324,7 @@ var Module = Class.extend({
 			// If a translation file is set, load it and then also load the fallback translation file.
 			// Otherwise only load the fallback translation file.
 			if (translationFile !== undefined && translationFile !== translationsFallbackFile) {
-				Translator.load(self, translationFile, false, function() {
+				Translator.load(self, translationFile, false, function () {
 					Translator.load(self, translationsFallbackFile, true, callback);
 				});
 			} else {
@@ -259,14 +335,18 @@ var Module = Class.extend({
 		}
 	},
 
- 	/* translate(key, defaultValue)
- 	 * Request the translation for a given key.
- 	 *
- 	 * argument key string - The key of the string to translage
-	 * argument defaultValue string - The default value if no translation was found. (Optional)
- 	 */
-	translate: function(key, defaultValue) {
-		return Translator.translate(this, key) || defaultValue || "";
+	/* translate(key, defaultValueOrVariables, defaultValue)
+	 * Request the translation for a given key with optional variables and default value.
+	 *
+	 * argument key string - The key of the string to translate
+     * argument defaultValueOrVariables string/object - The default value or variables for translating. (Optional)
+     * argument defaultValue string - The default value with variables. (Optional)
+	 */
+	translate: function (key, defaultValueOrVariables, defaultValue) {
+		if(typeof defaultValueOrVariables === "object") {
+			return Translator.translate(this, key, defaultValueOrVariables) || defaultValue || "";
+		}
+		return Translator.translate(this, key) || defaultValueOrVariables || "";
 	},
 
 	/* updateDom(speed)
@@ -274,27 +354,27 @@ var Module = Class.extend({
 	 *
 	 * argument speed Number - The speed of the animation. (Optional)
 	 */
-	updateDom: function(speed) {
+	updateDom: function (speed) {
 		MM.updateDom(this, speed);
 	},
 
 	/* sendNotification(notification, payload)
 	 * Send a notification to all modules.
 	 *
-	 * argument notification string - The identifier of the noitication.
+	 * argument notification string - The identifier of the notification.
 	 * argument payload mixed - The payload of the notification.
 	 */
-	sendNotification: function(notification, payload) {
+	sendNotification: function (notification, payload) {
 		MM.sendNotification(notification, payload, this);
 	},
 
 	/* sendSocketNotification(notification, payload)
 	 * Send a socket notification to the node helper.
 	 *
-	 * argument notification string - The identifier of the noitication.
+	 * argument notification string - The identifier of the notification.
 	 * argument payload mixed - The payload of the notification.
 	 */
-	sendSocketNotification: function(notification, payload) {
+	sendSocketNotification: function (notification, payload) {
 		this.socket().sendNotification(notification, payload);
 	},
 
@@ -303,15 +383,22 @@ var Module = Class.extend({
 	 *
 	 * argument speed Number - The speed of the hide animation.
 	 * argument callback function - Called when the animation is done.
+	 * argument options object - Optional settings for the hide method.
 	 */
-	hide: function(speed, callback) {
-		callback = callback || function() {};
+	hide: function (speed, callback, options) {
+		if (typeof callback === "object") {
+			options = callback;
+			callback = function () { };
+		}
+
+		callback = callback || function () { };
+		options = options || {};
 
 		var self = this;
-		MM.hideModule(self, speed, function() {
+		MM.hideModule(self, speed, function () {
 			self.suspend();
 			callback();
-		});
+		}, options);
 	},
 
 	/* showModule(module, speed, callback)
@@ -319,29 +406,29 @@ var Module = Class.extend({
 	 *
 	 * argument speed Number - The speed of the show animation.
 	 * argument callback function - Called when the animation is done.
+	 * argument options object - Optional settings for the hide method.
 	 */
-	show: function(speed, callback) {
+	show: function (speed, callback, options) {
+		if (typeof callback === "object") {
+			options = callback;
+			callback = function () { };
+		}
+
+		callback = callback || function () { };
+		options = options || {};
+
 		this.resume();
-		MM.showModule(this, speed, callback);
+		MM.showModule(this, speed, callback, options);
 	}
 });
 
 Module.definitions = {};
 
-Module.create = function(name) {
+Module.create = function (name) {
 
-	//Define the clone method for later use.
-	function cloneObject(obj) {
-		if (obj === null || typeof obj !== "object") {
-			return obj;
-		}
-
-		var temp = obj.constructor(); // give temp the original obj"s constructor
-		for (var key in obj) {
-			temp[key] = cloneObject(obj[key]);
-		}
-
-		return temp;
+	// Make sure module definition is available.
+	if (!Module.definitions[name]) {
+		return;
 	}
 
 	var moduleDefinition = Module.definitions[name];
@@ -351,10 +438,41 @@ Module.create = function(name) {
 	var ModuleClass = Module.extend(clonedDefinition);
 
 	return new ModuleClass();
-
 };
 
-Module.register = function(name, moduleDefinition) {
+/* cmpVersions(a,b)
+* Compare two semantic version numbers and return the difference.
+*
+* argument a string - Version number a.
+* argument a string - Version number b.
+*/
+function cmpVersions(a, b) {
+	var i, diff;
+	var regExStrip0 = /(\.0+)+$/;
+	var segmentsA = a.replace(regExStrip0, "").split(".");
+	var segmentsB = b.replace(regExStrip0, "").split(".");
+	var l = Math.min(segmentsA.length, segmentsB.length);
+
+	for (i = 0; i < l; i++) {
+		diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
+		if (diff) {
+			return diff;
+		}
+	}
+	return segmentsA.length - segmentsB.length;
+}
+
+Module.register = function (name, moduleDefinition) {
+
+	if (moduleDefinition.requiresVersion) {
+		Log.log("Check MagicMirror version for module '" + name + "' - Minimum version:  " + moduleDefinition.requiresVersion + " - Current version: " + version);
+		if (cmpVersions(version, moduleDefinition.requiresVersion) >= 0) {
+			Log.log("Version is ok!");
+		} else {
+			Log.log("Version is incorrect. Skip module: '" + name + "'");
+			return;
+		}
+	}
 	Log.log("Module registered: " + name);
 	Module.definitions[name] = moduleDefinition;
 };

js/server.js

@@ -10,21 +10,64 @@ var app = require("express")();
 var server = require("http").Server(app);
 var io = require("socket.io")(server);
 var path = require("path");
+var ipfilter = require("express-ipfilter").IpFilter;
+var fs = require("fs");
+var helmet = require("helmet");
+var Utils = require(__dirname + "/utils.js");
 
 var Server = function(config, callback) {
-	console.log("Starting server op port " + config.port + " ... ");
 
-	server.listen(config.port);
+	var port = config.port;
+	if (process.env.MM_PORT) {
+		port = process.env.MM_PORT;
+	}
+
+	console.log("Starting server on port " + port + " ... ");
+
+	server.listen(port, config.address ? config.address : null);
+
+	if (config.ipWhitelist instanceof Array && config.ipWhitelist.length === 0) {
+		console.info(Utils.colors.warn("You're using a full whitelist configuration to allow for all IPs"));
+	}
+
+	app.use(function(req, res, next) {
+		var result = ipfilter(config.ipWhitelist, {mode: config.ipWhitelist.length === 0 ? "deny" : "allow", log: false})(req, res, function(err) {
+			if (err === undefined) {
+				return next();
+			}
+			console.log(err.message);
+			res.status(403).send("This device is not allowed to access your mirror. <br> Please check your config.js or config.js.sample to change this.");
+		});
+	});
+	app.use(helmet());
+
 	app.use("/js", express.static(__dirname));
-	app.use("/config", express.static(path.resolve(__dirname + "/../config")));
-	app.use("/css", express.static(path.resolve(__dirname + "/../css")));
-	app.use("/fonts", express.static(path.resolve(__dirname + "/../fonts")));
-	app.use("/modules", express.static(path.resolve(__dirname + "/../modules")));
-	app.use("/vendor", express.static(path.resolve(__dirname + "/../vendor")));
-	app.use("/translations", express.static(path.resolve(__dirname + "/../translations")));
+	var directories = ["/config", "/css", "/fonts", "/modules", "/vendor", "/translations", "/tests/configs"];
+	var directory;
+	for (var i in directories) {
+		directory = directories[i];
+		app.use(directory, express.static(path.resolve(global.root_path + directory)));
+	}
+
+	app.get("/version", function(req,res) {
+		res.send(global.version);
+	});
+
+	app.get("/config", function(req,res) {
+		res.send(config);
+	});
 
 	app.get("/", function(req, res) {
-		res.sendFile(path.resolve(__dirname + "/../index.html"));
+		var html = fs.readFileSync(path.resolve(global.root_path + "/index.html"), {encoding: "utf8"});
+		html = html.replace("#VERSION#", global.version);
+
+		configFile = "config/config.js";
+		if (typeof(global.configuration_file) !== "undefined") {
+		    configFile = global.configuration_file;
+		}
+		html = html.replace("#CONFIG_FILE#", configFile);
+
+		res.send(html);
 	});
 
 	if (typeof callback === "function") {

js/socketclient.js

@@ -22,7 +22,6 @@ var MMSocket = function(moduleName) {
 	// register catch all.
 	self.socket.on("*", function(notification, payload) {
 		if (notification !== "*") {
-			//console.log('Received notification: ' + notification +', payload: ' + payload);
 			notificationCallback(notification, payload);
 		}
 	});

js/translator.js

@@ -18,7 +18,7 @@ var Translator = (function() {
 		xhr.overrideMimeType("application/json");
 		xhr.open("GET", file, true);
 		xhr.onreadystatechange = function () {
-			if (xhr.readyState == 4 && xhr.status == "200") {
+			if (xhr.readyState === 4 && xhr.status === 200) {
 				callback(JSON.parse(stripComments(xhr.responseText)));
 			}
 		};
@@ -111,41 +111,61 @@ var Translator = (function() {
 		translations: {},
 		translationsFallback: {},
 
-		/* translate(module, key)
+		/* translate(module, key, variables)
 		 * Load a translation for a given key for a given module.
 		 *
 		 * argument module Module - The module to load the translation for.
 		 * argument key string - The key of the text to translate.
+		 * argument variables - The variables to use within the translation template (optional)
 		 */
-		translate: function(module, key) {
+		translate: function(module, key, variables) {
+			variables = variables || {}; //Empty object by default
+
+			// Combines template and variables like:
+			// template: "Please wait for {timeToWait} before continuing with {work}."
+			// variables: {timeToWait: "2 hours", work: "painting"}
+			// to: "Please wait for 2 hours before continuing with painting."
+			function createStringFromTemplate(template, variables) {
+				if(Object.prototype.toString.call(template) !== "[object String]") {
+					return template;
+				}
+				if(variables.fallback && !template.match(new RegExp("\{.+\}"))) {
+					template = variables.fallback;
+				}
+				return template.replace(new RegExp("\{([^\}]+)\}", "g"), function(_unused, varName){
+					return variables[varName] || "{"+varName+"}";
+				});
+			}
 
 			if(this.translations[module.name] && key in this.translations[module.name]) {
 				// Log.log("Got translation for " + key + " from module translation: ");
-				return this.translations[module.name][key];
+				return createStringFromTemplate(this.translations[module.name][key], variables);
 			}
 
 			if (key in this.coreTranslations) {
 				// Log.log("Got translation for " + key + " from core translation.");
-				return this.coreTranslations[key];
+				return createStringFromTemplate(this.coreTranslations[key], variables);
 			}
 
 			if (this.translationsFallback[module.name] && key in this.translationsFallback[module.name]) {
 				// Log.log("Got translation for " + key + " from module translation fallback.");
-				return this.translationsFallback[module.name][key];
+				return createStringFromTemplate(this.translationsFallback[module.name][key], variables);
 			}
 
 			if (key in this.coreTranslationsFallback) {
 				// Log.log("Got translation for " + key + " from core translation fallback.");
-				return this.coreTranslationsFallback[key];
+				return createStringFromTemplate(this.coreTranslationsFallback[key], variables);
 			}
 
 			return key;
 		},
-		/* load(module, file, callback)
+
+		/* load(module, file, isFallback, callback)
 		 * Load a translation file (json) and remember the data.
 		 *
 		 * argument module Module - The module to load the translation file for.
 		 * argument file string - Path of the file we want to load.
+		 * argument isFallback boolean - Flag to indicate fallback translations.
 		 * argument callback function - Function called when done.
 		 */
 		load: function(module, file, isFallback, callback) {
@@ -201,10 +221,12 @@ var Translator = (function() {
 			// defined translation after the following line.
 			for (var first in translations) {break;}
 
-			Log.log("Loading core translation fallback file: " + translations[first]);
-			loadJSON(translations[first], function(translations) {
-				self.coreTranslationsFallback = translations;
-			});
+			if (first) {
+				Log.log("Loading core translation fallback file: " + translations[first]);
+				loadJSON(translations[first], function(translations) {
+					self.coreTranslationsFallback = translations;
+				});
+			}
 		},
 	};
 })();

js/utils.js

@@ -0,0 +1,19 @@
+/* exported Utils */
+/* Magic Mirror
+ * Utils
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var colors = require("colors/safe");
+
+var Utils = {
+	colors: {
+		warn: colors.yellow,
+		error: colors.red,
+		info: colors.blue
+	}
+};
+
+if (typeof module !== "undefined") {module.exports = Utils;}

jsconfig.json

@@ -0,0 +1,13 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=759670
+	// for the documentation about the jsconfig.json format
+	"compilerOptions": {
+		"target": "es6",
+		"module": "commonjs",
+		"allowSyntheticDefaultImports": true
+	},
+	"exclude": [
+		"modules",
+		"node_modules"
+	]
+}

module-types.ts

@@ -0,0 +1,31 @@
+type ModuleProperties = {
+  defaults?: object,
+  start?(): void,
+  getHeader?(): string,
+  getTemplate?(): string,
+  getTemplateData?(): object,
+  notificationReceived?(notification: string, payload: any, sender: object): void,
+  socketNotificationReceived?(notification: string, payload: any): void,
+  suspend?(): void,
+  resume?(): void,
+  getDom?(): HTMLElement,
+  getStyles?(): string[],
+  [key: string]: any,
+};
+
+export declare const Module: {
+  register(moduleName: string, moduleProperties: ModuleProperties): void;
+};
+
+export declare const Log: {
+  info(message?: any, ...optionalParams: any[]): void,
+  log(message?: any, ...optionalParams: any[]): void,
+  error(message?: any, ...optionalParams: any[]): void,
+  warn(message?: any, ...optionalParams: any[]): void,
+  group(groupTitle?: string, ...optionalParams: any[]): void,
+  groupCollapsed(groupTitle?: string, ...optionalParams: any[]): void,
+  groupEnd(): void,
+  time(timerName?: string): void,
+  timeEnd(timerName?: string): void,
+  timeStamp(timerName?: string): void,
+};

modules/README.md

@@ -2,19 +2,55 @@
 
 This document describes the way to develop your own MagicMirror² modules.
 
+Table of Contents:
+
+- Module structure
+  - Files
+
+- The Core module file: modulename.js
+  - Available module instance properties
+  - Subclassable module methods
+  - Module instance methods
+  - Visibility locking
+
+- The Node Helper: node_helper.js
+  - Available module instance properties
+  - Subclassable module methods
+  - Module instance methods
+  
+- MagicMirror Helper Methods
+  - Module Selection
+
+- MagicMirror Logger
+
+---
+
+
+## General Advice
+
+As MagicMirror has gained huge popularity, so has the number of available modules. For new users and developers alike, it is very time consuming to navigate around the various repositories in order to find out what exactly a certain modules does, how it looks and what it depends on. Unfortunately, this information is rarely available, nor easily obtained without having to install it first. 
+Therefore **we highly recommend you to include the following information in your README file.**
+
+- A high quality screenshot of your working module
+- A short, one sentence, clear description what it does (duh!)
+- What external API's it depends upon, including web links to those
+- Whether the API/request require a key and the user limitations of those. (Is it free?)
+
+Surely this also help you get better recognition and feedback for your work. 
+
 ## Module structure
 
-All modules are loaded in de `modules` folder. The default modules are grouped together in the `modules/default` folder. Your module should be placed in a subfolder of `modules`. Note that any file or folder your create in the `modules` folder will be ignored by git, allowing you to upgrade the MagicMirror² without the loss of your files.
+All modules are loaded in the `modules` folder. The default modules are grouped together in the `modules/default` folder. Your module should be placed in a subfolder of `modules`. Note that any file or folder your create in the `modules` folder will be ignored by git, allowing you to upgrade the MagicMirror² without the loss of your files.
 
-A module can be placed in one single folder. Or multiple modules can be grouped in a subfoler. Note that name of the module must be unique. Even when a module with a similar name is placed in a different folder, they can't be loaded at the same time.
+A module can be placed in one single folder. Or multiple modules can be grouped in a subfolder. Note that name of the module must be unique. Even when a module with a similar name is placed in a different folder, they can't be loaded at the same time.
 
 ### Files
 - **modulename/modulename.js** - This is your core module script.
-- **modulename/node_helper.js** - This is an optional helper that whill be loaded by the node script. The node helper and module script can communicate with each other using an intergrated socket system.
-- **modulename/public** - Any files in this folder can be accesed via the browser on `/modulename/filename.ext`.
+- **modulename/node_helper.js** - This is an optional helper that will be loaded by the node script. The node helper and module script can communicate with each other using an integrated socket system.
+- **modulename/public** - Any files in this folder can be accessed via the browser on `/modulename/filename.ext`.
 - **modulename/anyfileorfolder** Any other file or folder in the module folder can be used by the core module script. For example: *modulename/css/modulename.css* would be a good path for your additional module styles.
 
-## Core module file: modulename.js
+## The Core module file: modulename.js
 This is the script in which the module will be defined. This script is required in order for the module to be used. In it's most simple form, the core module file must contain:
 ````javascript
 Module.register("modulename",{});
@@ -44,30 +80,16 @@ As you can see, the `Module.register()` method takes two arguments: the name of
 ### Available module instance properties
 After the module is initialized, the module instance has a few available module properties:
 
-####`this.name`
-**String**
+| Instance Property | Type | Description |
+|:----------------- |:---- |:----------- |
+| `this.name` | String | The name of the module. |
+| `this.identifier` | String | This is a unique identifier for the module instance. |
+| `this.hidden` | Boolean | This represents if the module is currently hidden (faded away). |
+| `this.config` | Boolean | The configuration of the module instance as set in the user's `config.js` file. This config will also contain the module's defaults if these properties are not over-written by the user config. |
+| `this.data` | Object | The data object contain additional metadata about the module instance. (See below) |
 
-The name of the module.
 
-####`this.identifier`
-**String**
-
-This is a unique identifier for the module instance.
-
-####`this.hidden`
-**Boolean**
-
-This represents if the module is currently hidden (faded away).
-
-####`this.config`
-**Boolean**
-
-The configuration of the module instance as set in the user's config.js file. This config will also contain the module's defaults if these properties are not over written by the user config.
-
-####`this.data`
-**Object**
-
-The data object contains additional metadata about the module instance:
+The `this.data` data object contain the following metadata:
 - `data.classes` - The classes which are added to the module dom wrapper.
 - `data.file` - The filename of the core module file.
 - `data.path` - The path of the module folder.
@@ -75,16 +97,44 @@ The data object contains additional metadata about the module instance:
 - `data.position` - The position in which the instance will be shown.
 
 
-####`defaults: {}`
-Any properties defined in the defaults object, will be merged with the module config as defined in the user's config.js file. This is the best place to set your modules's configuration defaults. Any of the module configuration properties can be accessed using `this.config.propertyName`, but more about that later.
+#### `defaults: {}`
+Any properties defined in the defaults object, will be merged with the module config as defined in the user's config.js file. This is the best place to set your modules' configuration defaults. Any of the module configuration properties can be accessed using `this.config.propertyName`, but more about that later.
+
+#### `requiresVersion:`
+
+*Introduced in version: 2.1.0.*
+
+A string that defines the minimum version of the MagicMirror framework. If it is set, the system compares the required version with the users version. If the version of the user is out of date, it won't run the module. Make sure to also set this value in the Node helper.
+
+**Note:** Since this check is introduced in version 2.1.0, this check will not be run in older versions. Keep this in mind if you get issue reports on your module.
+
+Example:
+````javascript
+requiresVersion: "2.1.0",
+````
 
 ### Subclassable module methods
 
-####`init()`
+#### `init()`
 This method is called when a module gets instantiated. In most cases you do not need to subclass this method.
 
-####`start()`
-This method is called when all modules are loaded an the system is ready to boot up. Keep in mind that the dom object for the module is not yet created. The start method is a perfect place to define any additional module properties:
+#### `loaded(callback)`
+
+*Introduced in version: 2.1.1.*
+
+This method is called when a module is loaded. Subsequent modules in the config are not yet loaded. The `callback` function MUST be called when the module is done loading. In most cases you do not need to subclass this method.
+
+**Example:**
+````javascript
+loaded: function(callback) {
+	this.finishLoading();
+	Log.log(this.name + ' is loaded!');
+	callback();
+}
+````
+
+#### `start()`
+This method is called when all modules are loaded and the system is ready to boot up. Keep in mind that the dom object for the module is not yet created. The start method is a perfect place to define any additional module properties:
 
 **Example:**
 ````javascript
@@ -94,7 +144,7 @@ start: function() {
 }
 ````
 
-####`getScripts()`
+#### `getScripts()`
 **Should return: Array**
 
 The getScripts method is called to request any additional scripts that need to be loaded. This method should therefore return an array with strings. If you want to return a full path to a file in the module folder, use the `this.file('filename.js')` method. In all cases the loader will only load a file once. It even checks if the file is available in the default vendor folder.
@@ -104,17 +154,17 @@ The getScripts method is called to request any additional scripts that need to b
 getScripts: function() {
 	return [
 		'script.js', // will try to load it from the vendor folder, otherwise it will load is from the module folder.
-		'moment.js', // this file is available in the vendor folder, so it doesn't need to be avialable in the module folder.
+		'moment.js', // this file is available in the vendor folder, so it doesn't need to be available in the module folder.
 		this.file('anotherfile.js'), // this file will be loaded straight from the module folder.
 		'https://code.jquery.com/jquery-2.2.3.min.js',  // this file will be loaded from the jquery servers.
 	]
 }
 
 ````
-**Note:** If a file can not be loaded, the boot up of the mirror will stall. Therefore it's advised not to use any external urls.
+**Note:** If a file can not be loaded, the boot up of the mirror will stall. Therefore, it's advised not to use any external urls.
 
 
-####`getStyles()`
+#### `getStyles()`
 **Should return: Array**
 
 The getStyles method is called to request any additional stylesheets that need to be loaded. This method should therefore return an array with strings. If you want to return a full path to a file in the module folder, use the `this.file('filename.css')` method. In all cases the loader will only load a file once. It even checks if the file is available in the default vendor folder.
@@ -124,16 +174,16 @@ The getStyles method is called to request any additional stylesheets that need t
 getStyles: function() {
 	return [
 		'script.css', // will try to load it from the vendor folder, otherwise it will load is from the module folder.
-		'font-awesome.css', // this file is available in the vendor folder, so it doesn't need to be avialable in the module folder.
+		'font-awesome.css', // this file is available in the vendor folder, so it doesn't need to be available in the module folder.
 		this.file('anotherfile.css'), // this file will be loaded straight from the module folder.
 		'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css',  // this file will be loaded from the bootstrapcdn servers.
 	]
 }
 
 ````
-**Note:** If a file can not be loaded, the boot up of the mirror will stall. Therefore it's advised not to use any external urls.
+**Note:** If a file can not be loaded, the boot up of the mirror will stall. Therefore, it's advised not to use any external URLs.
 
-####`getTranslations()`
+#### `getTranslations()`
 **Should return: Dictionary**
 
 The getTranslations method is called to request translation files that need to be loaded. This method should therefore return a dictionary with the files to load, identified by the country's short name.
@@ -151,10 +201,10 @@ getTranslations: function() {
 
 ````
 
-####`getDom()`
+#### `getDom()`
 **Should return:** Dom Object
 
-Whenever the MagicMirror needs to update the information on screen (because it starts, or because your module asked a refresh using `this.updateDom()`), the system calls the getDom method. This method should therefor return a dom object.
+Whenever the MagicMirror needs to update the information on screen (because it starts, or because your module asked a refresh using `this.updateDom()`), the system calls the getDom method. This method should therefore return a dom object.
 
 **Example:**
 ````javascript
@@ -166,13 +216,30 @@ getDom: function() {
 
 ````
 
-####`notificationReceived(notification, payload, sender)`
+#### `getHeader()`
+**Should return:** String
+
+Whenever the MagicMirror needs to update the information on screen (because it starts, or because your module asked a refresh using `this.updateDom()`), the system calls the getHeader method to retrieve the module's header. This method should therefor return a string. If this method is not subclassed, this function will return the user's configured header.
+
+If you want to use the original user's configured header, reference `this.data.header`.
+
+**NOTE:** If the user did not configure a default header, no header will be displayed and thus this method will not be called.
+
+**Example:**
+````javascript
+getHeader: function() {
+	return this.data.header + ' Foo Bar';
+}
+
+````
+
+#### `notificationReceived(notification, payload, sender)`
 
 That MagicMirror core has the ability to send notifications to modules. Or even better: the modules have the possibility to send notifications to other modules. When this module is called, it has 3 arguments:
 
 - `notification` - String - The notification identifier.
 - `payload` - AnyType - The payload of a notification.
-- `sender` - Module - The sender of the notification. If this argument is `undefined`, the sender of the notififiction is the core system.
+- `sender` - Module - The sender of the notification. If this argument is `undefined`, the sender of the notification is the core system.
 
 **Example:**
 ````javascript
@@ -185,21 +252,22 @@ notificationReceived: function(notification, payload, sender) {
 }
 ````
 
-**Note:** the system sends two notifiations when starting up. These notifications could come in handy!
+**Note:** the system sends three notifications when starting up. These notifications could come in handy!
 
 
 - `ALL_MODULES_STARTED` - All modules are started. You can now send notifications to other modules.
 - `DOM_OBJECTS_CREATED` - All dom objects are created. The system is now ready to perform visual changes.
+- `MODULE_DOM_CREATED` - This module's dom has been fully loaded. You can now access your module's dom objects.
 
 
-####`socketNotificationReceived: function(notification, payload)`
+#### `socketNotificationReceived: function(notification, payload)`
 When using a node_helper, the node helper can send your module notifications. When this module is called, it has 2 arguments:
 
 - `notification` - String - The notification identifier.
 - `payload` - AnyType - The payload of a notification.
 
-**Note 1:** When a node helper send a notification, all modules of that module type receive the same notifications. <br>
-**Note 2:** The socket connection is established as soon as the module sends it's first message using [sendSocketNotification](thissendsocketnotificationnotification-payload).
+**Note 1:** When a node helper sends a notification, all modules of that module type receive the same notifications. <br>
+**Note 2:** The socket connection is established as soon as the module sends its first message using [sendSocketNotification](#thissendsocketnotificationnotification-payload).
 
 **Example:**
 ````javascript
@@ -208,28 +276,28 @@ socketNotificationReceived: function(notification, payload) {
 },
 ````
 
-####`suspend()`
+#### `suspend()`
 When a module is hidden (using the `module.hide()` method), the `suspend()` method will be called. By subclassing this method you can perform tasks like halting the update timers.
 
-####`resume()`
-When a module will be shown after it was previously hidden (using the `module.show()` method), the `resume()` method will be called. By subclassing this method you can perform tasks restarting the update timers.
+#### `resume()`
+When a module is requested to be shown (using the `module.show()` method), the `resume()` method will be called. By subclassing this method you can perform tasks restarting the update timers.
 
 
 ### Module instance methods
 
-Each module instance has some handy methods which can be helpfull building your module.
+Each module instance has some handy methods which can be helpful building your module.
 
 
-####`this.file(filename)`
+#### `this.file(filename)`
 ***filename* String** - The name of the file you want to create the path for.<br>
 **Returns String**
 
 If you want to create a path to a file in your module folder, use the `file()` method. It returns the path to the filename given as the attribute. Is method comes in handy when configuring the [getScripts](#getscripts) and [getStyles](#getstyles) methods.
 
-####`this.updateDom(speed)`
+#### `this.updateDom(speed)`
 ***speed* Number** - Optional. Animation speed in milliseconds.<br>
 
-Whenever your module need to be updated, call the `updateDom(speed)` method. It requests the MagicMirror core to update it's dom object. If you define the speed, the content update will be animated, but only if the content will realy change.
+Whenever your module need to be updated, call the `updateDom(speed)` method. It requests the MagicMirror core to update its dom object. If you define the speed, the content update will be animated, but only if the content will really change.
 
 As an example: the clock modules calls this method every second:
 
@@ -244,49 +312,119 @@ start: function() {
 ...
 ````
 
-####`this.sendNotification(notification, payload)`
+#### `this.sendNotification(notification, payload)`
 ***notification* String** - The notification identifier.<br>
 ***payload* AnyType** - Optional. A notification payload.<br>
 
-If you want to send a notification to all other modules, use the `sendNotification(notification, payload)`. All other modules will receive the message via the [notificationReceived](#notificationreceivednotification-payload-sender) method. In that case, the sender is automaticly set to the instance calling the sendNotification method.
+If you want to send a notification to all other modules, use the `sendNotification(notification, payload)`. All other modules will receive the message via the [notificationReceived](#notificationreceivednotification-payload-sender) method. In that case, the sender is automatically set to the instance calling the sendNotification method.
 
 **Example:**
 ````javascript
 this.sendNotification('MYMODULE_READY_FOR_ACTION', {foo:bar});
 ````
 
-####`this.sendSocketNotification(notification, payload)`
+#### `this.sendSocketNotification(notification, payload)`
 ***notification* String** - The notification identifier.<br>
 ***payload* AnyType** - Optional. A notification payload.<br>
 
-If you want to send a notification to the node_helper, use the `sendSocketNotification(notification, payload)`. Only the node_helper of this module will recieve the socket notification.
+If you want to send a notification to the node_helper, use the `sendSocketNotification(notification, payload)`. Only the node_helper of this module will receive the socket notification.
 
 **Example:**
 ````javascript
 this.sendSocketNotification('SET_CONFIG', this.config);
 ````
 
-####`this.hide(speed, callback)`
-***speed* Number** - Optional, The speed of the hide animation in milliseconds.
+#### `this.hide(speed, callback, options)`
+***speed* Number** - Optional (Required when setting callback or options), The speed of the hide animation in milliseconds.
 ***callback* Function** - Optional, The callback after the hide animation is finished.
+***options* Function** - Optional, Object with additional options for the hide action (see below). (*Introduced in version: 2.1.0.*)
 
-To hide a module, you can call the `hide(speed, callback)` method. You can call the hide method on the module instance itselve using `this.hide()`, but of course you can also hide an other module using `anOtherModule.hide()`.
+To hide a module, you can call the `hide(speed, callback)` method. You can call the hide method on the module instance itself using `this.hide()`, but of course you can also hide another module using `anOtherModule.hide()`.
 
-**Note 1:** If the hide animation is canceled, for instance because the show method is called before the hide animation was finished, the callback will not be called.<br>
+Possible configurable options:
+
+- `lockString` - String - When setting lock string, the module can not be shown without passing the correct lockstring. This way (multiple) modules can prevent a module from showing. It's considered best practice to use your modules identifier as the locksString: `this.identifier`. See *visibility locking* below.
+
+
+**Note 1:** If the hide animation is cancelled, for instance because the show method is called before the hide animation was finished, the callback will not be called.<br>
 **Note 2:** If the hide animation is hijacked (an other method calls hide on the same module), the callback will not be called.<br>
 **Note 3:** If the dom is not yet created, the hide method won't work. Wait for the `DOM_OBJECTS_CREATED` [notification](#notificationreceivednotification-payload-sender).
 
-####`this.show(speed, callback)`
-***speed* Number** - Optional, The speed of the show animation in milliseconds.
-***callback* Function** - Optional, The callback after the show animation is finished.
 
-To show a module, you can call the `show(speed, callback)` method. You can call the show method on the module instance itselve using `this.show()`, but of course you can also show an other module using `anOtherModule.show()`.
+#### `this.show(speed, callback, options)`
+***speed* Number** - Optional (Required when setting callback or options), The speed of the show animation in milliseconds.
+***callback* Function** - Optional, The callback after the show animation is finished.
+***options* Function** - Optional, Object with additional options for the show action (see below). (*Introduced in version: 2.1.0.*)
+
+To show a module, you can call the `show(speed, callback)` method. You can call the show method on the module instance itself using `this.show()`, but of course you can also show another module using `anOtherModule.show()`.
+
+Possible configurable options:
+
+- `lockString` - String - When setting lock string, the module can not be shown without passing the correct lockstring. This way (multiple) modules can prevent a module from showing. See *visibility locking* below.
+- `force` - Boolean - When setting the force tag to `true`, the locking mechanism will be overwritten. Use this option with caution. It's considered best practice to let the usage of the force option be use- configurable. See *visibility locking* below.
 
 **Note 1:** If the show animation is canceled, for instance because the hide method is called before the show animation was finished, the callback will not be called.<br>
 **Note 2:** If the show animation is hijacked (an other method calls show on the same module), the callback will not be called.<br>
 **Note 3:** If the dom is not yet created, the show method won't work. Wait for the `DOM_OBJECTS_CREATED` [notification](#notificationreceivednotification-payload-sender).
 
-####`this.translate(identifier)`
+#### Visibility locking
+
+(*Introduced in version: 2.1.0.*)
+
+Visibility locking helps the module system to prevent unwanted hide/show actions. The following scenario explains the concept:
+
+**Module B asks module A to hide:**
+````javascript
+moduleA.hide(0, {lockString: "module_b_identifier"});
+````
+Module A is now hidden, and has an lock array with the following strings:
+````javascript
+moduleA.lockStrings == ["module_b_identifier"]
+moduleA.hidden == true
+````
+**Module C asks module A to hide:**
+````javascript
+moduleA.hide(0, {lockString: "module_c_identifier"});
+````
+Module A is now hidden, and has an lock array with the following strings:
+````javascript
+moduleA.lockStrings == ["module_b_identifier", "module_c_identifier"]
+moduleA.hidden == true
+````
+**Module B asks module A to show:**
+````javascript
+moduleA.show(0, {lockString: "module_b_identifier"});
+````
+The lockString will be removed from moduleA’s locks array, but since there still is an other lock string available, the module remains hidden:
+````javascript
+moduleA.lockStrings == ["module_c_identifier"]
+moduleA.hidden == true
+````
+**Module C asks module A to show:**
+````javascript
+moduleA.show(0, {lockString: "module_c_identifier"});
+````
+The lockString will be removed from moduleA’s locks array, and since this will result in an empty lock array, the module will be visible:
+````javascript
+moduleA.lockStrings == []
+moduleA.hidden == false
+````
+
+**Note:** The locking mechanism can be overwritten by using the force tag:
+````javascript
+moduleA.show(0, {force: true});
+````
+This will reset the lockstring array, and will show the module.
+````javascript
+moduleA.lockStrings == []
+moduleA.hidden == false
+````
+
+Use this `force` method with caution. See `show()` method for more information.
+
+
+
+#### `this.translate(identifier)`
 ***identifier* String** - Identifier of the string that should be translated.
 
 The Magic Mirror contains a convenience wrapper for `l18n`. You can use this to automatically serve different translations for your modules based on the user's `language` configuration.
@@ -298,7 +436,7 @@ If no translation is found, a fallback will be used. The fallback sequence is as
 - 4. Translation as defined in core translation file of the fallback language (the first defined core translation file).
 - 5. The key (identifier) of the translation.
 
-When adding translations to your module, it's a good idea to see if an apropriate translation is already available in the [core translation files](https://github.com/MichMich/MagicMirror/tree/master/translations). This way, your module can benefit from the existing translations.
+When adding translations to your module, it's a good idea to see if an appropriate translation is already available in the [core translation files](https://github.com/MichMich/MagicMirror/tree/master/translations). This way, your module can benefit from the existing translations.
 
 **Example:**
 ````javascript
@@ -314,6 +452,51 @@ this.translate("INFO") //Will return a translated string for the identifier INFO
 
 **Note:** although comments are officially not supported in JSON files, MagicMirror allows it by stripping the comments before parsing the JSON file. Comments in translation files could help other translators.
 
+##### `this.translate(identifier, variables)`
+***identifier* String** - Identifier of the string that should be translated.
+***variables* Object** - Object of variables to be used in translation.
+
+This improved and backwards compatible way to handle translations behaves like the normal translation function and follows the rules described above. It's recommended to use this new format for translating everywhere. It allows translator to change the word order in the sentence to be translated.
+
+
+**Example:**
+````javascript
+var timeUntilEnd = moment(event.endDate, "x").fromNow(true);
+this.translate("RUNNING", { "timeUntilEnd": timeUntilEnd) }); // Will return a translated string for the identifier RUNNING, replacing `{timeUntilEnd}` with the contents of the variable `timeUntilEnd` in the order that translator intended.
+````
+
+**Example English .json file:**
+````javascript
+{
+	"RUNNING": "Ends in {timeUntilEnd}",
+}
+````
+
+**Example Finnish .json file:**
+````javascript
+{
+	"RUNNING": "Päättyy {timeUntilEnd} päästä",
+}
+````
+
+**Note:** The *variables* Object has an special case called `fallback`. It's used to support old translations in translation files that do not have the variables in them. If you are upgrading an old module that had translations that did not support the word order, it is recommended to have the fallback layout.
+
+**Example:**
+````javascript
+var timeUntilEnd = moment(event.endDate, "x").fromNow(true);
+this.translate("RUNNING", {
+	"fallback": this.translate("RUNNING") + " {timeUntilEnd}"
+	"timeUntilEnd": timeUntilEnd
+)}); // Will return a translated string for the identifier RUNNING, replacing `{timeUntilEnd}` with the contents of the variable `timeUntilEnd` in the order that translator intended. (has a fallback)
+````
+
+**Example Swedish .json file that does not have the variable in it:**
+````javascript
+{
+	"RUNNING": "Slutar",
+}
+````
+In this case the `translate`-function will not find any variables in the translation, will look for `fallback` variable and use that if possible to create the translation.
 
 ## The Node Helper: node_helper.js
 
@@ -328,21 +511,21 @@ var NodeHelper = require("node_helper");
 module.exports = NodeHelper.create({});
 ````
 
-Of course, the above helper would not do anything usefull. So with the information above, you should be able to make it a bit more sophisticated.
+Of course, the above helper would not do anything useful. So with the information above, you should be able to make it a bit more sophisticated.
 
 ### Available module instance properties
 
-####`this.name`
+#### `this.name`
 **String**
 
 The name of the module
 
-####`this.path`
+#### `this.path`
 **String**
 
 The path of the module
 
-####`this.expressApp`
+#### `this.expressApp`
 **Express App Instance**
 
 This is a link to the express instance. It will allow you to define extra routes.
@@ -356,23 +539,36 @@ start: function() {
 }
 ````
 
-**Note: ** By default, a public path to your module's public folder will be created:
+**Note:** By default, a public path to your module's public folder will be created:
 ````javascript
 this.expressApp.use("/" + this.name, express.static(this.path + "/public"));
 ````
 
-####`this.io`
+#### `this.io`
 **Socket IO Instance**
 
 This is a link to the IO instance. It will allow you to do some Socket.IO magic. In most cases you won't need this, since the Node Helper has a few convenience methods to make this simple.
 
+
+#### `requiresVersion:`
+*Introduced in version: 2.1.0.*
+
+A string that defines the minimum version of the MagicMirror framework. If it is set, the system compares the required version with the users version. If the version of the user is out of date, it won't run the module.
+
+**Note:** Since this check is introduced in version 2.1.0, this check will not be run in older versions. Keep this in mind if you get issue reports on your module.
+
+Example:
+````javascript
+requiresVersion: "2.1.0",
+````
+
 ### Subclassable module methods
 
-####`init()`
+#### `init()`
 This method is called when a node helper gets instantiated. In most cases you do not need to subclass this method.
 
-####`start()`
-This method is called when all node helper are loaded an the system is ready to boot up. The start method is a perfect place to define any additional module properties:
+#### `start()`
+This method is called when all node helpers are loaded and the system is ready to boot up. The start method is a perfect place to define any additional module properties:
 
 **Example:**
 ````javascript
@@ -382,13 +578,24 @@ start: function() {
 }
 ````
 
-####`socketNotificationReceived: function(notification, payload)`
-With this method, your node helper can receive notifications form your modules. When this method is called, it has 2 arguments:
+#### `stop()`
+This method is called when the MagicMirror server receives a `SIGINT` command and is shutting down. This method should include any commands needed to close any open connections, stop any sub-processes and gracefully exit the module.
+
+**Example:**
+````javascript
+stop: function() {
+	console.log("Shutting down MyModule");
+	this.connection.close();
+}
+````
+
+#### `socketNotificationReceived: function(notification, payload)`
+With this method, your node helper can receive notifications from your modules. When this method is called, it has 2 arguments:
 
 - `notification` - String - The notification identifier.
 - `payload` - AnyType - The payload of a notification.
 
-**Note:** The socket connection is established as soon as the module sends it's first message using [sendSocketNotification](thissendsocketnotificationnotification-payload).
+**Note:** The socket connection is established as soon as the module sends its first message using [sendSocketNotification](thissendsocketnotificationnotification-payload).
 
 **Example:**
 ````javascript
@@ -399,15 +606,15 @@ socketNotificationReceived: function(notification, payload) {
 
 ### Module instance methods
 
-Each node helper has some handy methods which can be helpfull building your module.
+Each node helper has some handy methods which can be helpful building your module.
 
-####`this.sendSocketNotification(notification, payload)`
+#### `this.sendSocketNotification(notification, payload)`
 ***notification* String** - The notification identifier.<br>
 ***payload* AnyType** - Optional. A notification payload.<br>
 
-If you want to send a notification to all your modules, use the `sendSocketNotification(notification, payload)`. Only the module of your module type will recieve the socket notification.
+If you want to send a notification to all your modules, use the `sendSocketNotification(notification, payload)`. Only the module of your module type will receive the socket notification.
 
-**Note:** Since all instances of you module will receive the notifications, it's your task to make sure the right module responds to your messages.
+**Note:** Since all instances of your module will receive the notifications, it's your task to make sure the right module responds to your messages.
 
 **Example:**
 ````javascript
@@ -421,7 +628,7 @@ The core Magic Mirror object: `MM` has some handy method that will help you in c
 ### Module selection
 The only additional method available for your module, is the feature to retrieve references to other modules. This can be used to hide and show other modules.
 
-####`MM.getModules()`
+#### `MM.getModules()`
 **Returns Array** - An array with module instances.<br>
 
 To make a selection of all currently loaded module instances, run the `MM.getModules()` method. It will return an array with all currently loaded module instances. The returned array has a lot of filtering methods. See below for more info.
@@ -429,11 +636,11 @@ To make a selection of all currently loaded module instances, run the `MM.getMod
 **Note:** This method returns an empty array if not all modules are started yet. Wait for the `ALL_MODULES_STARTED` [notification](#notificationreceivednotification-payload-sender).
 
 
-#####`.withClass(classnames)`
-***classnames* String or Array** - The class names on which you want to filer.
+##### `.withClass(classnames)`
+***classnames* String or Array** - The class names on which you want to filter.
 **Returns Array** - An array with module instances.<br>
 
-If you want to make a selection based on one ore more class names, use the withClass method on a result of the `MM.getModules()` method. The argument of the `withClass(classname)` method can be an array, or space separated string.
+If you want to make a selection based on one or more class names, use the withClass method on a result of the `MM.getModules()` method. The argument of the `withClass(classname)` method can be an array, or space separated string.
 
 **Examples:**
 ````javascript
@@ -442,7 +649,7 @@ var modules = MM.getModules().withClass('classname1 classname2');
 var modules = MM.getModules().withClass(['classname1','classname2']);
 ````
 
-#####`.exceptWithClass(classnames)`
+##### `.exceptWithClass(classnames)`
 ***classnames* String or Array** - The class names of the modules you want to remove from the results.
 **Returns Array** - An array with module instances.<br>
 
@@ -455,11 +662,11 @@ var modules = MM.getModules().exceptWithClass('classname1 classname2');
 var modules = MM.getModules().exceptWithClass(['classname1','classname2']);
 ````
 
-#####`.exceptModule(module)`
+##### `.exceptModule(module)`
 ***module* Module Object** - The reference to a module you want to remove from the results.
 **Returns Array** - An array with module instances.<br>
 
-If you to remove a specific module instance from a selection based on a classname, use the exceptWithClass method on a result of the `MM.getModules()` method. This can be helpfull if you want to select all module instances except the instance of your module.
+If you to remove a specific module instance from a selection based on a classname, use the exceptWithClass method on a result of the `MM.getModules()` method. This can be helpful if you want to select all module instances except the instance of your module.
 
 **Examples:**
 ````javascript
@@ -473,7 +680,7 @@ Of course, you can combine all of the above filters:
 var modules = MM.getModules().withClass('classname1').exceptwithClass('classname2').exceptModule(aModule);
 ````
 
-#####`.enumerate(callback)`
+##### `.enumerate(callback)`
 ***callback* Function(module)** - The callback run on every instance.
 
 If you want to perform an action on all selected modules, you can use the `enumerate` function:

modules/default/alert/README.md

@@ -7,10 +7,10 @@ To use this module, add it to the modules array in the config/config.js file:
 ```
 modules: [
 	{
-		module: 'alert',
+		module: "alert",
 		config: {
 			// The config property is optional.
-			// See 'Configuration options' for more information. 
+			// See 'Configuration options' for more information.
 		}
 	}
 ]
@@ -21,145 +21,45 @@ modules: [
 The following properties can be configured:
 
 
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-		<tr>
-			<td><code>effect</code></td>
-			<td>The animation effect to use for notifications.<br>
-				<br><b>Possible values:</b> <code>scale</code> <code>slide</code> <code>genie</code> <code>jelly</code> <code>flip</code> <code>exploader</code> <code>bouncyflip</code>
-				<br><b>Default value:</b> <code>slide</code>
-			</td>
-		</tr>
-		<td><code>alert_effect</code></td>
-			<td>The animation effect to use for alerts.<br>
-				<br><b>Possible values:</b> <code>scale</code> <code>slide</code> <code>genie</code> <code>jelly</code> <code>flip</code> <code>exploader</code> <code>bouncyflip</code>
-				<br><b>Default value:</b> <code>jelly</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>display_time</code></td>
-			<td>Time a notification is displayed in seconds.<br>
-				<br><b>Possible values:</b> <code>float</code> <code>int</code>
-				<br><b>Default value:</b> <code>3.5</code>
-			</td>
-		</tr>
-		<tr>
-		<tr>
-			<td><code>position</code></td>
-			<td>Position where the notifications should be displayed.<br>
-				<br><b>Possible values:</b> <code>left</code> <code>center</code> <code>right</code>
-				<br><b>Default value:</b> <code>center</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>welcome_message</code></td>
-			<td>Message shown at startup.<br>
-				<br><b>Possible values:</b> <code>string</code> <code>false</code>
-				<br><b>Default value:</b> <code>Welcome, start was successfull!</code>
-			</td>
-		</tr>
-	</tbody>
-</table>
+| Option            | Description
+| ----------------- | -----------
+| `effect`          | The animation effect to use for notifications. <br><br> **Possible values:** `scale` `slide` `genie` `jelly` `flip` `exploader` `bouncyflip` <br> **Default value:** `slide`
+| `alert_effect`    | The animation effect to use for alerts. <br><br> **Possible values:** `scale` `slide` `genie` `jelly` `flip` `exploader` `bouncyflip` <br> **Default value:** `jelly`
+| `display_time`    | Time a notification is displayed in milliseconds. <br><br> **Possible values:** `int` <br> **Default value:** `3500`
+| `position`        | Position where the notifications should be displayed. <br><br> **Possible values:** `left` `center` `right` <br> **Default value:** `center`
+| `welcome_message` | Message shown at startup. <br><br> **Possible values:** `string` `false` <br> **Default value:** `false` (no message at startup)
 
 
 ## Developer notes
 For notifications use:
 
 ```
-self.sendNotification("SHOW_ALERT", {type: "notification"}); 
+self.sendNotification("SHOW_ALERT", {type: "notification"});
 ```
 For alerts use:
 
 ```
-self.sendNotification("SHOW_ALERT", {}); 
+self.sendNotification("SHOW_ALERT", {});
 ```
 
 ### Notification params
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-		<tr>
-			<td><code>title</code></td>
-			<td>The title of the notification.<br>
-				<br><b>Possible values:</b> <code>text</code> or <code>html</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>message</code></td>
-			<td>The message of the notification.<br>
-				<br><b>Possible values:</b> <code>text</code> or <code>html</code>
-			</td>
-		</tr>
-	</tbody>
-</table>
+| Option             | Description
+| ------------------ | -----------
+| `title`            | The title of the notification. <br><br> **Possible values:** `text` or `html`
+| `message`	         | The message of the notification. <br><br> **Possible values:** `text` or `html`
+| `timer` (optional) | How long the notification should stay visible in ms. <br> If absent, the default `display_time` is used. <br> **Possible values:** `int` `float`
+
 
 ### Alert params
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-		<tr>
-			<td><code>title</code></td>
-			<td>The title of the alert.<br>
-				<br><b>Possible values:</b> <code>text</code> or <code>html</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>message</code></td>
-			<td>The message of the alert.<br>
-				<br><b>Possible values:</b> <code>text</code> or <code>html</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>imageUrl</code> (optional)</td>
-			<td>Image to show in the alert<br>
-				<br><b>Possible values:</b> <code>url</code> <code>path</code>
-				<br><b>Default value:</b> <code>none</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>imageFA</code> (optional)</td>
-			<td>Font Awesome icon to show in the alert<br>
-				<br><b>Possible values:</b> See <a href="http://fontawesome.io/icons/" target="_blank">Font Awsome</a> website.
-				<br><b>Default value:</b> <code>none</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>imageHeight</code> (optional even with imageUrl set)</td>
-			<td>Height of the image<br>
-				<br><b>Possible values:</b> <code>intpx</code>
-				<br><b>Default value:</b> <code>80px</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>timer</code> (optional)</td>
-			<td>How long the alert should stay visible in ms.
-			<br><b>Important:</b> If you do not use the <code>timer</code>, it is your duty to hide the alert by using <code>self.sendNotification("HIDE_ALERT");</code>!<br>
-				<br><b>Possible values:</b> <code>int</code> <code>float</code>
-				<br><b>Default value:</b> <code>none</code>
-			</td>
-		</tr>
-	</tbody>
-</table>
+| Option                                          | Description
+| ----------------------------------------------- | -----------
+| `title`                                         | The title of the alert. <br><br> **Possible values:** `text` or `html`
+| `message`                                       | The message of the alert. <br><br> **Possible values:** `text` or `html`
+| `imageUrl` (optional)                           | Image to show in the alert <br><br> **Possible values:** `url` `path` <br> **Default value:** `none`
+| `imageFA` (optional)                            | Font Awesome icon to show in the alert <br><br> **Possible values:** See [Font Awsome](http://fontawesome.io/icons/) website. <br> **Default value:** `none`
+| `imageHeight` (optional even with imageUrl set) | Height of the image <br><br> **Possible values:** `intpx` <br> **Default value:** `80px`
+| `timer` (optional)                              | How long the alert should stay visible in ms. <br> **Important:** If you do not use the `timer`, it is your duty to hide the alert by using `self.sendNotification("HIDE_ALERT");`! <br><br>**Possible values:** `int` `float` <br> **Default value:** `none`
 
 ## Open Source Licenses
-###[NotificationStyles](https://github.com/codrops/NotificationStyles)
-See [ympanus.net](http://tympanus.net/codrops/licensing/) for license.
+### [NotificationStyles](https://github.com/codrops/NotificationStyles)
+See [tympanus.net](http://tympanus.net/codrops/licensing/) for license.

modules/default/alert/alert.js

@@ -24,34 +24,34 @@ Module.register("alert",{
 		return ["classie.js", "modernizr.custom.js", "notificationFx.js"];
 	},
 	getStyles: function() {
-		return ["ns-default.css"];
+		return ["ns-default.css", "font-awesome.css"];
 	},
 	// Define required translations.
 	getTranslations: function() {
 		return {
 			en: "translations/en.json",
-			de: "translations/de.json"
+			de: "translations/de.json",
+			nl: "translations/nl.json",
 		};
 	},
 	show_notification: function(message) {
-		if (this.config.effect == "slide") {this.config.effect = this.config.effect + "-" + this.config.position;}
-		
+		if (this.config.effect === "slide") {this.config.effect = this.config.effect + "-" + this.config.position;}
 		msg = "";
 		if (message.title) {
-			msg += "<span class='thin' style='line-height: 35px; font-size:24px' color='#4A4A4A'>" + message.title + "</span>";
+			msg += "<span class='thin dimmed medium'>" + message.title + "</span>";
 		}
 		if (message.message){
-			if (msg != ""){
+			if (msg !== ""){
 				msg+= "<br />";
 			}
-			msg += "<span class='light' style='font-size:28px;line-height: 30px;'>" + message.message + "</span>";
+			msg += "<span class='light bright small'>" + message.message + "</span>";
 		}
-		
+
 		new NotificationFx({
 			message: msg,
 			layout: "growl",
 			effect: this.config.effect,
-			ttl: this.config.display_time
+			ttl: message.timer !== undefined ? message.timer : this.config.display_time
 		}).show();
 	},
 	show_alert: function(params, sender) {
@@ -63,9 +63,9 @@ Module.register("alert",{
 			params.imageUrl = null;
 			image = "";
 		} else if (typeof params.imageFA === "undefined"){
-			image = "<img src='" + (params.imageUrl).toString() + "' height=" + (params.imageHeight).toString() + " style='margin-bottom: 10px;'/><br />";
+			image = "<img src='" + (params.imageUrl).toString() + "' height='" + (params.imageHeight).toString() + "' style='margin-bottom: 10px;'/><br />";
 		} else if (typeof params.imageUrl === "undefined"){
-			image = "<span class='" + "fa fa-" + params.imageFA + "' style='margin-bottom: 10px;color: #fff;font-size:" + (params.imageHeight).toString() + ";'/></span><br />";
+			image = "<span class='bright " + "fa fa-" + params.imageFA + "' style='margin-bottom: 10px;font-size:" + (params.imageHeight).toString() + ";'/></span><br />";
 		}
 		//Create overlay
 		var overlay = document.createElement("div");
@@ -79,16 +79,16 @@ Module.register("alert",{
 		}
 
 		//Display title and message only if they are provided in notification parameters
-		message ="";
+		var message = "";
 		if (params.title) {
-			message += "<span class='light' style='line-height: 35px; font-size:30px' color='#4A4A4A'>" + params.title + "</span>"
+			message += "<span class='light dimmed medium'>" + params.title + "</span>";
 		}
 		if (params.message) {
-			if (message != ""){
+			if (message !== ""){
 				message += "<br />";
 			}
 
-			message += "<span class='thin' style='font-size:22px;line-height: 30px;'>" + params.message + "</span>";
+			message += "<span class='thin bright small'>" + params.message + "</span>";
 		}
 
 		//Store alert in this.alerts
@@ -110,27 +110,29 @@ Module.register("alert",{
 	},
 	hide_alert: function(sender) {
 		//Dismiss alert and remove from this.alerts
-		this.alerts[sender.name].dismiss();
-		this.alerts[sender.name] = null;
-		//Remove overlay
-		var overlay = document.getElementById("overlay");
-		overlay.parentNode.removeChild(overlay);
+		if (this.alerts[sender.name]) {
+			this.alerts[sender.name].dismiss();
+			this.alerts[sender.name] = null;
+			//Remove overlay
+			var overlay = document.getElementById("overlay");
+			overlay.parentNode.removeChild(overlay);
+		}
 	},
 	setPosition: function(pos) {
 		//Add css to body depending on the set position for notifications
 		var sheet = document.createElement("style");
-		if (pos == "center") {sheet.innerHTML = ".ns-box {margin-left: auto; margin-right: auto;text-align: center;}";}
-		if (pos == "right") {sheet.innerHTML = ".ns-box {margin-left: auto;text-align: right;}";}
-		if (pos == "left") {sheet.innerHTML = ".ns-box {margin-right: auto;text-align: left;}";}
+		if (pos === "center") {sheet.innerHTML = ".ns-box {margin-left: auto; margin-right: auto;text-align: center;}";}
+		if (pos === "right") {sheet.innerHTML = ".ns-box {margin-left: auto;text-align: right;}";}
+		if (pos === "left") {sheet.innerHTML = ".ns-box {margin-right: auto;text-align: left;}";}
 		document.body.appendChild(sheet);
 
 	},
 	notificationReceived: function(notification, payload, sender) {
 		if (notification === "SHOW_ALERT") {
 			if (typeof payload.type === "undefined") { payload.type = "alert"; }
-			if (payload.type == "alert") {
+			if (payload.type === "alert") {
 				this.show_alert(payload, sender);
-			} else if (payload.type = "notification") {
+			} else if (payload.type === "notification") {
 				this.show_notification(payload);
 			}
 		} else if (notification === "HIDE_ALERT") {
@@ -141,7 +143,7 @@ Module.register("alert",{
 		this.alerts = {};
 		this.setPosition(this.config.position);
 		if (this.config.welcome_message) {
-			if (this.config.welcome_message == true){
+			if (this.config.welcome_message === true){
 				this.show_notification({title: this.translate("sysTitle"), message: this.translate("welcome")});
 			}
 			else{
@@ -150,5 +152,4 @@ Module.register("alert",{
 		}
 		Log.info("Starting module: " + this.name);
 	}
-
 });