From 6c68434adb8dd3b355920599f0f8358d401791a5 Mon Sep 17 00:00:00 2001 From: Jan Date: Tue, 31 Aug 2021 00:10:29 +0200 Subject: [PATCH 1/7] Update and rename bug_report.md to bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.md | 63 ---------------- .github/ISSUE_TEMPLATE/bug_report.yml | 101 ++++++++++++++++++++++++++ 2 files changed, 101 insertions(+), 63 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 7695cd4..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -## I found a bug in this module -Hello and thank you for helping to improve this module. -Please make sure to only submit reproducible issues and to provide as much information as possible. - -**Describe the bug** -A clear and concise description of what the bug is. -``` - -``` - -**To Reproduce** -Steps to reproduce the behavior: -``` - -``` - -**Expected behavior** -A clear and concise description of what you expected to happen. -``` - -``` - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Logfiles** -If possible, please provide server and/or browser console log files. -``` - -``` - -**Module Version / Commit ID** -Which version of this module are you using? You can get this information by executing `git log` within the module's directory. Please provide the first row of the result, e.g. `commit f8ae15ffb6b5e4f5d5f9cc436f8e697d02737982 (tag: v.2.0.2)` -``` - -``` - -**Module Configuration** -Please provide the used module configuration which was used when you faced this bug. -``` - -``` - -**Magic Mirror Version** -Which version of MagicMirror are you running. It can be found in the `MagicMirror/package.log` file. -``` - -``` - -**Additional context** -Add any other context about the problem here. -``` - -``` diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..2dce01d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,101 @@ +name: Bug Report +description: Think you found a bug? Let us know! +labels: [bug, to check] +body: + - type: markdown + attributes: + value: | + Hello and thank you for helping to improve this module. + Please make sure to only submit reproducible issues. + + - type: input + attributes: + label: Platform + description: | + Tell us about the platform on which you run your MagicMirror. + placeholder: 'Raspberry Pi OS' + validations: + required: false + - type: input + attributes: + label: Node.js Version + description: | + You'll get your Node.js version by executing `node -v` in your terminal. + placeholder: '14.17.5' + validations: + required: false + - type: input + attributes: + label: MagicMirror Version + description: | + Which version of MagicMirror are you running? It can be found in the `MagicMirror/package.log` file. + placeholder: '2.16.0' + validations: + required: true + - type: input + attributes: + label: Module Version + description: | + What's the module's version / Commit ID? You can get this information by executing `git log` within the module's directory. Please provide the first row of the result, e.g. commit f8ae15ffb6b5e4f5d5f9cc436f8e697d02737982 (tag: v.2.0.2) + placeholder: 'v.2.0.2 or f8ae15ffb6b5e4f5d5f9cc436f8e697d02737982' + validations: + required: true + - type: textarea + attributes: + label: Description + description: Please describe the bug as clear and concise as possible. + validations: + required: true + - type: textarea + attributes: + label: Expected behavior + description: What should actually happen? + validations: + required: false + - type: textarea + attributes: + label: Current behavior + description: What happened instead? + validations: + required: false + - type: textarea + attributes: + label: Possible solution + description: You can suggest a reason for the bug, if know about it. + validations: + required: false + - type: textarea + attributes: + label: Steps to reproduce + description: Please give details about how do you reach that behavior + placeholder: | + 1. Start MM... + 2. Wait until everything loads + 3. Click button... + 4. See error... + validations: + required: true + - type: textarea + attributes: + label: Log + description: | + Paste the log you're getting, and possibly the error. + **Please don't forget to remove sensitive information!** + render: shell + validations: + required: false + - type: textarea + attributes: + label: config.js + description: | + Paste here your config.js file. + **Please don't forget to remove sensitive information!** + render: javascript + validations: + required: true + - type: textarea + attributes: + label: Additional info + description: Everything else that you think could be useful. + validations: + required: false From 99ee2a51800ee8ee5fc7cf7c52509cbf15028bbc Mon Sep 17 00:00:00 2001 From: Jan Date: Tue, 31 Aug 2021 00:13:07 +0200 Subject: [PATCH 2/7] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 2dce01d..5d1d1ed 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -36,7 +36,7 @@ body: attributes: label: Module Version description: | - What's the module's version / Commit ID? You can get this information by executing `git log` within the module's directory. Please provide the first row of the result, e.g. commit f8ae15ffb6b5e4f5d5f9cc436f8e697d02737982 (tag: v.2.0.2) + What's the module's version / Commit ID? You can get this information by executing `git log` within the module's directory. placeholder: 'v.2.0.2 or f8ae15ffb6b5e4f5d5f9cc436f8e697d02737982' validations: required: true From 1dbca6f6c88a5d91d48c0550ee44295e0b08fac0 Mon Sep 17 00:00:00 2001 From: Jan Date: Wed, 1 Sep 2021 17:56:14 +0200 Subject: [PATCH 3/7] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 422dbfd..e3aae4d 100644 --- a/README.md +++ b/README.md @@ -58,8 +58,8 @@ https://user-images.githubusercontent.com/25933231/130909536-e096d342-19d5-4139- { lat: 49.15, lng: 6.154, zoom: 5, loops: 2 }, ], mapUrl: "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png", - mapHeight: "420px", - mapWidth: "420px", + mapHeight: "420px", // must be a pixel value (no percent) + mapWidth: "420px", // must be a pixel value (no percent) maxHistoryFrames: -1, maxForecastFrames: -1, substitudeModules: [], @@ -83,8 +83,8 @@ https://user-images.githubusercontent.com/25933231/130909536-e096d342-19d5-4139- | `extraDelayCurrentFrameMs` | Add an extra delay to pause the animation on the frame for the current weather situation.

**Type:** `int`
**Default value:** `3000` (time in milliseconds) | | `markers` | Optional list of markers on the map.
See examples and Markers-Object documentation below for details.

**Type:** `array[Marker]`
**Default value:** `Sample set` | | `mapPositions` | **Required:** List of zoom/center positions for the map.
See examples and MapPosition-Object documentation below for details.

**Type:** `array[MapPosition]`
**Default value:** `Sample set` | -| `mapHeight` | Height of the map.

**Type:** `string` (pixels)
**Default value:** `'420px'` | -| `mapWidth` | Width of the map.

**Type:** `string` (pixels)
**Default value:** `'420px'` | +| `mapHeight` | Height of the map. Must be string with pixels and "px" postfix. Percentage values won't work.

**Type:** `string` (pixels)
**Default value:** `'420px'` | +| `mapWidth` | Width of the map. Must be a string with pixels and "px" postfix. Percentage values won't work.

**Type:** `string` (pixels)
**Default value:** `'420px'` | | `mapUrl` | Option to use an alternative map. In most cases you are fine with the default but you can find more maps [here](https://wiki.openstreetmap.org/wiki/Tile_servers).

**Type:** `string`
**Default value:** `'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'`
**Alternative uncolored map:** '`https://tiles.wmflabs.org/bw-mapnik/${z}/${x}/${y}.png`' | | `maxHistoryFrames` | Maximum number of history frames. There is one frame every 10 minutes. Setting this to 6 would show history radar layers of the last hour until now. If set to -1, all available history frames are shown.
As of today, the **API provides 12 history frames** -> 2h.

**Type:** `int`
**Default value:** `-1` | | `maxForecastFrames` | Maximum number of forecast frames. There is one frame every 10 minutes. Setting this to 2 would show forecast radar layers from now to 20 minutes in the future. If set to -1, all available forecast frames are shown.
As of today, the **API provides 3 forecast frames** -> 30min.

**Type:** `int`
**Default value:** `-1` @@ -113,4 +113,4 @@ https://user-images.githubusercontent.com/25933231/130909536-e096d342-19d5-4139- - Thanks to all supporters who gave a small [donation](https://www.buymeacoffee.com/jalibu) out of gratitude for my work. - All testers for their feedback. -- [MMM-RAIN-RADAR by jojoduquartier](https://github.com/jojoduquartier/MMM-RAIN-RADAR) for inspiration. \ No newline at end of file +- [MMM-RAIN-RADAR by jojoduquartier](https://github.com/jojoduquartier/MMM-RAIN-RADAR) for inspiration. From 1be666093db03056d0f95aa6b9e66e1a67e0cf67 Mon Sep 17 00:00:00 2001 From: Jan Date: Thu, 2 Sep 2021 18:15:40 +0200 Subject: [PATCH 4/7] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e3aae4d..ccaa5f5 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # MMM-RAIN-MAP -A Rain Radar Map for [Magic Mirror](https://magicmirror.builders/) based on the [Rainviewer API](https://github.com/rainviewer/rainviewer-api-example). +A Rain Radar Map based on the [Rainviewer API](https://www.rainviewer.com/) for the [MagicMirror² platform](https://magicmirror.builders/). + Click here for the [Forum Thread](https://forum.magicmirror.builders/topic/12808/mmm-rain-map). #### Support -If you like this module and want to thank, please buy me a coffee. +If you like this module and want to thank, please rate this repository with a star or buy me a coffee :-) Buy Me A Beer From 6141153764897869a0835ec1ca028334ed872b77 Mon Sep 17 00:00:00 2001 From: Jan Date: Thu, 2 Sep 2021 18:16:06 +0200 Subject: [PATCH 5/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ccaa5f5..60e0e21 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MMM-RAIN-MAP -A Rain Radar Map based on the [Rainviewer API](https://www.rainviewer.com/) for the [MagicMirror² platform](https://magicmirror.builders/). +A Rain Radar Map based on the [Rainviewer API](https://www.rainviewer.com/) for the [MagicMirror²](https://magicmirror.builders/) platform. Click here for the [Forum Thread](https://forum.magicmirror.builders/topic/12808/mmm-rain-map). From 37045e1a5e4b743323df750a68cd967910a52c1f Mon Sep 17 00:00:00 2001 From: Jan Date: Thu, 2 Sep 2021 18:23:33 +0200 Subject: [PATCH 6/7] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 60e0e21..31775a0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +[![dependencies Status](https://status.david-dm.org/gh/jalibu/MMM-RAIN-MAP.svg)](https://david-dm.org/jalibu/MMM-RAIN-MAP) [![Known Vulnerabilities](https://snyk.io/test/github/jalibu/MMM-RAIN-MAP/badge.svg?targetFile=package.json)](https://snyk.io/test/github/jalibu/MMM-RAIN-MAP?targetFile=package.json) # MMM-RAIN-MAP A Rain Radar Map based on the [Rainviewer API](https://www.rainviewer.com/) for the [MagicMirror²](https://magicmirror.builders/) platform. From 046da62e5fd3abe030d4bad6fe73d07130d0b037 Mon Sep 17 00:00:00 2001 From: Jan Date: Thu, 2 Sep 2021 18:24:06 +0200 Subject: [PATCH 7/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 31775a0..1687a0a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -[![dependencies Status](https://status.david-dm.org/gh/jalibu/MMM-RAIN-MAP.svg)](https://david-dm.org/jalibu/MMM-RAIN-MAP) [![Known Vulnerabilities](https://snyk.io/test/github/jalibu/MMM-RAIN-MAP/badge.svg?targetFile=package.json)](https://snyk.io/test/github/jalibu/MMM-RAIN-MAP?targetFile=package.json) # MMM-RAIN-MAP +[![dependencies Status](https://status.david-dm.org/gh/jalibu/MMM-RAIN-MAP.svg)](https://david-dm.org/jalibu/MMM-RAIN-MAP) [![Known Vulnerabilities](https://snyk.io/test/github/jalibu/MMM-RAIN-MAP/badge.svg?targetFile=package.json)](https://snyk.io/test/github/jalibu/MMM-RAIN-MAP?targetFile=package.json) A Rain Radar Map based on the [Rainviewer API](https://www.rainviewer.com/) for the [MagicMirror²](https://magicmirror.builders/) platform.