From c1c52cc2a9ce6f10b35b122191b3897b01fbac0b Mon Sep 17 00:00:00 2001 From: Jordan Welch Date: Sun, 26 Oct 2025 09:14:19 -0500 Subject: [PATCH 1/5] Add workflow to check PRs for errors --- .github/workflows/pr-check.yml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/workflows/pr-check.yml diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml new file mode 100644 index 00000000..85f3c4b2 --- /dev/null +++ b/.github/workflows/pr-check.yml @@ -0,0 +1,32 @@ +name: Check Pull Request +on: + pull_request: + types: + - opened + - synchronize + - reopened + branches: + - master + +concurrency: + group: pr-check-${{ github.event.pull_request.number }} + cancel-in-progress: true + +jobs: + test: + runs-on: ubuntu-latest + + steps: + - name: Checkout Repository + uses: actions/checkout@v5 + + - name: Install Node.js + uses: actions/setup-node@v5 + with: + node-version: 22 + + - name: Install Dependencies + run: npm ci --ignore-scripts + + - name: Run Tests + run: npm run test From d5a126bb3f07666c2bb3e12619ca1307e2bef8af Mon Sep 17 00:00:00 2001 From: Jordan Welch Date: Sun, 26 Oct 2025 09:15:44 -0500 Subject: [PATCH 2/5] Lint --- .github/workflows/pr-check.yml | 28 ++++++++++++++-------------- configuration/raspberry.md | 14 +++++++++----- getting-started/installation.md | 11 ++++++++++- 3 files changed, 33 insertions(+), 20 deletions(-) diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml index 85f3c4b2..626bb205 100644 --- a/.github/workflows/pr-check.yml +++ b/.github/workflows/pr-check.yml @@ -2,11 +2,11 @@ name: Check Pull Request on: pull_request: types: - - opened - - synchronize - - reopened + - opened + - synchronize + - reopened branches: - - master + - master concurrency: group: pr-check-${{ github.event.pull_request.number }} @@ -17,16 +17,16 @@ jobs: runs-on: ubuntu-latest steps: - - name: Checkout Repository - uses: actions/checkout@v5 + - name: Checkout Repository + uses: actions/checkout@v5 - - name: Install Node.js - uses: actions/setup-node@v5 - with: - node-version: 22 + - name: Install Node.js + uses: actions/setup-node@v5 + with: + node-version: 22 - - name: Install Dependencies - run: npm ci --ignore-scripts + - name: Install Dependencies + run: npm ci --ignore-scripts - - name: Run Tests - run: npm run test + - name: Run Tests + run: npm run test diff --git a/configuration/raspberry.md b/configuration/raspberry.md index bbb0619d..27cc4696 100644 --- a/configuration/raspberry.md +++ b/configuration/raspberry.md @@ -1,11 +1,13 @@ # Raspberry Specific -This information here is based on the latest release of -[Raspberry Pi OS](https://www.raspberrypi.com/software/operating-systems/) ("Trixie") from October 1st 2025. +This information here is based on the latest release of +[Raspberry Pi OS](https://www.raspberrypi.com/software/operating-systems/) +("Trixie") from October 1st 2025. ## Adding colored icons -Raspberry Pi OS does not come with colored emoji icons by default. To add them, install the following package: +Raspberry Pi OS does not come with colored emoji icons by default. To add them, +install the following package: ```shell sudo apt install fonts-noto-color-emoji @@ -13,8 +15,10 @@ sudo apt install fonts-noto-color-emoji ## Rotating the screen -See the [official documentation](https://www.raspberrypi.com/documentation/computers/configuration.html#set-resolution-and-rotation) +See the +[official documentation](https://www.raspberrypi.com/documentation/computers/configuration.html#set-resolution-and-rotation) -In case you still run an older version of the Raspberry Pi OS, you can follow these instructions: +In case you still run an older version of the Raspberry Pi OS, you can follow +these instructions: https://pimylifeup.com/raspberry-pi-rotate-screen/ diff --git a/getting-started/installation.md b/getting-started/installation.md index c5f705e4..460e47f3 100644 --- a/getting-started/installation.md +++ b/getting-started/installation.md @@ -27,22 +27,31 @@ the install specific instructions below 2. Check if `git` is installed on your machine by executing `git` (should show usage), otherwise install it 3. Clone the repository: + ```shell git clone https://github.com/MagicMirrorOrg/MagicMirror ``` -4. Enter the repository: + +4. Enter the repository: + ```shell cd MagicMirror ``` + 5. Install the application: `` + ```shell node --run install-mm ``` + 6. Make a copy of the config sample file: + ```shell cp config/config.js.sample config/config.js ``` + 7. Start the application: + ```shell node --run start ``` From 1f97ca5f2a42d0a05b6c78146ca92bac0fdd020c Mon Sep 17 00:00:00 2001 From: Jordan Welch Date: Sun, 26 Oct 2025 09:18:58 -0500 Subject: [PATCH 3/5] Add words to dictionary --- cspell.config.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/cspell.config.json b/cspell.config.json index fd0650d6..5beb0f3b 100644 --- a/cspell.config.json +++ b/cspell.config.json @@ -2,7 +2,6 @@ "version": "0.2", "language": "en", "words": [ - "Deepwiki", "anyfileorfolder", "apikey", "Autorestart", @@ -12,6 +11,8 @@ "custommodules", "dateheaders", "datetype", + "Deepwiki", + "endfor", "envcanada", "exploader", "feelslike", @@ -34,6 +35,7 @@ "newpos", "newsfeed", "nohup", + "noto", "oenstrom", "onecall", "openmeteo", @@ -59,6 +61,7 @@ "Teeuw", "Termine", "timeformat", + "Trixie", "trunc", "tympanus", "ukmetoffice", From 56e9a7850d815a31366b5d0eb9eb56c6f126632e Mon Sep 17 00:00:00 2001 From: Jordan Welch Date: Sun, 26 Oct 2025 13:38:48 -0500 Subject: [PATCH 4/5] use current --- .github/workflows/pr-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml index 626bb205..8209537b 100644 --- a/.github/workflows/pr-check.yml +++ b/.github/workflows/pr-check.yml @@ -23,7 +23,7 @@ jobs: - name: Install Node.js uses: actions/setup-node@v5 with: - node-version: 22 + node-version: current - name: Install Dependencies run: npm ci --ignore-scripts From 83cb4fee3ed98f12fb0d06d2bd93cc01787924b4 Mon Sep 17 00:00:00 2001 From: Jordan Welch Date: Sun, 26 Oct 2025 13:39:38 -0500 Subject: [PATCH 5/5] Use current `actions/setup-node` --- .github/workflows/pr-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml index 8209537b..7236ea7d 100644 --- a/.github/workflows/pr-check.yml +++ b/.github/workflows/pr-check.yml @@ -21,7 +21,7 @@ jobs: uses: actions/checkout@v5 - name: Install Node.js - uses: actions/setup-node@v5 + uses: actions/setup-node@v6 with: node-version: current