feat: add demo configuration file and add package.json script

Author: KristjanESPERANTO

CONTRIBUTING.md

@@ -14,6 +14,7 @@ Please note that this project is released with a [Contributor Code of Conduct](C
 ## Developer commands
 
 - `npm install` - Install all dependencies.
+- `node --run demo` - Start MagicMirror with demo config showcasing module features.
 - `node --run download_modules` - Download module list manually.
 - `node --run lint` - Run linting and formatter checks.
 - `node --run lint:fix` - Fix linting and formatter issues.

demo.config.js

@@ -0,0 +1,120 @@
+let config = {
+  address: "0.0.0.0",
+  ipWhitelist: [],
+  logLevel: ["INFO", "LOG", "WARN", "ERROR", "DEBUG"],
+  modules: [
+    {
+      module: "clock",
+      position: "top_left",
+      config: {
+        displaySeconds: false,
+        showPeriod: true,
+        showDate: true
+      }
+    },
+    {
+      module: "weather",
+      position: "top_right",
+      config: {
+        weatherProvider: "openmeteo",
+        type: "current",
+        location: "Berlin",
+        locationID: "2950159",
+        lat: 52.52,
+        lon: 13.41
+      }
+    },
+    {
+      module: "weather",
+      position: "top_right",
+      config: {
+        weatherProvider: "openmeteo",
+        type: "forecast",
+        location: "Berlin",
+        locationID: "2950159",
+        lat: 52.52,
+        lon: 13.41
+      }
+    },
+    {
+      module: "calendar",
+      position: "top_left",
+      header: "Upcoming Events",
+      config: {
+        calendars: [
+          {
+            url: "https://calendar.google.com/calendar/ical/en.german%23holiday%40group.v.calendar.google.com/public/basic.ics",
+            symbol: "calendar"
+          }
+        ]
+      }
+    },
+    {
+      module: "newsfeed",
+      position: "bottom_bar",
+      config: {
+        feeds: [
+          {
+            title: "New York Times",
+            url: "https://rss.nytimes.com/services/xml/rss/nyt/HomePage.xml"
+          }
+        ],
+        showSourceTitle: true,
+        showPublishDate: true,
+        updateInterval: 300_000
+      }
+    },
+    {
+      module: "compliments",
+      position: "lower_third",
+      config: {
+        compliments: {
+          morning: [
+            "Good morning!",
+            "Have a great day!",
+            "You look great today!"
+          ],
+          afternoon: [
+            "Hello!",
+            "You look nice!",
+            "Looking good today!"
+          ],
+          evening: [
+            "Good evening!",
+            "Have a nice evening!",
+            "You look relaxed!"
+          ]
+        }
+      }
+    },
+    {
+      module: "MMM-Remote-Control",
+      config: {
+        secureEndpoints: false,
+        classes: {
+          "Toggle Weather": {
+            toggle: ["weather"]
+          },
+          "Toggle Calendar": {
+            toggle: ["calendar"]
+          },
+          "Toggle News": {
+            toggle: ["newsfeed"]
+          },
+          "Night Mode": {
+            hide: ["weather", "calendar", "newsfeed", "compliments"]
+          },
+          "Morning Mode": {
+            show: ["clock", "weather", "calendar", "compliments"],
+            hide: ["newsfeed"]
+          }
+        }
+      }
+    }
+  ]
+};
+
+/** ************* DO NOT EDIT THE LINE BELOW */
+if (typeof module !== "undefined") {
+  module.exports = config;
+}

package.json

@@ -24,6 +24,7 @@
   ],
   "type": "commonjs",
   "scripts": {
+    "demo": "cd ../../ && MM_CONFIG_FILE=modules/MMM-Remote-Control/demo.config.js node --run start:wayland:dev",
     "download_modules": "node ./scripts/download_modules_manually.mjs",
     "lint": "eslint && prettier . --check",
     "lint:fix": "eslint --fix && prettier . --write",