Skip to content

feat: Add Download Page#105

Merged
petejohanson merged 11 commits intozmkfirmware:mainfrom
Nicell:download-page
Jan 16, 2025
Merged

feat: Add Download Page#105
petejohanson merged 11 commits intozmkfirmware:mainfrom
Nicell:download-page

Conversation

@Nicell
Copy link
Copy Markdown
Member

@Nicell Nicell commented Dec 8, 2024

Adds a download page to make the GitHub releases page for the app a little easier to use. This page gets the latest GitHub release, detects the current platform, and gives the download options in a clean way. Also shows all download options if the OS can't be detected.

image

@netlify
Copy link
Copy Markdown

netlify bot commented Dec 8, 2024

Deploy Preview for zmk-studio ready!

Name Link
🔨 Latest commit f407ab8
🔍 Latest deploy log https://app.netlify.com/sites/zmk-studio/deploys/677c3f9e0dd83d00081c72fe
😎 Deploy Preview https://deploy-preview-105.preview.zmk.studio
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Nicell Nicell marked this pull request as ready for review December 8, 2024 01:42
Comment on lines +4 to +7
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/zmk.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ZMK Studio - Download</title>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought: not required but it'd be nice to have when sharing the app link.

Suggested change
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/zmk.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ZMK Studio - Download</title>
<title>Download ZMK Studio</title>
<meta name="description" content="ZMK Studio provides runtime update functionality to ZMK powered devices, allowing users to change their keymap layers without flashing new firmware to their keyboards.">
<meta property="og:title" content="Download ZMK Studio">
<meta property="og:description" content="ZMK Studio provides runtime update functionality to ZMK powered devices, allowing users to change their keymap layers without flashing new firmware to their keyboards.">
<meta property="og:image" content="https://zmk.studio/zmk.svg">
<meta property="og:url" content="https://zmk.studio/download">
<meta property="og:site_name" content="Download ZMK Studio">
<meta property="og:type" content="website">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="Download ZMK Studio">
<meta name="twitter:description" content="ZMK Studio provides runtime update functionality to ZMK powered devices, allowing users to change their keymap layers without flashing new firmware to their keyboards.">
<meta name="twitter:image" content="https://zmk.studio/zmk.svg">

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair, I think we should do it as a follow-up since index.html is lacking this as well.

Copy link
Copy Markdown
Collaborator

@petejohanson petejohanson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this. A couple discussion points.

setShowAll(true);
}

fetch("https://api.github.com/repos/zmkfirmware/zmk-studio/releases/latest")
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to worry about GH rate limiting folks? Any reason not to build this in during build to avoid fetching from the API constantly?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had originally done this for simplicity. I saw another popular app do the same thing, but I can't find it now. I've refactored this to run a generation script before dev/build. Seems to work well.

@Nicell Nicell requested a review from petejohanson January 6, 2025 20:38
Copy link
Copy Markdown
Collaborator

@petejohanson petejohanson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@petejohanson petejohanson merged commit 2b88c5c into zmkfirmware:main Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants