Skip to content

Commit

Permalink
feat: Add Download Page (#105)
Browse files Browse the repository at this point in the history
Add a download page to easily allow downloading the latest release.
  • Loading branch information
Nicell authored Jan 16, 2025
1 parent 3370faa commit 2b88c5c
Show file tree
Hide file tree
Showing 11 changed files with 326 additions and 10 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ node_modules
dist
dist-ssr
*.local
src/data

# Editor directories and files
.vscode/*
Expand Down
13 changes: 13 additions & 0 deletions download.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!DOCTYPE html>
<html lang="en">
<head>
<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>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/download.tsx"></script>
</body>
</html>
84 changes: 79 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 7 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,19 @@
"version": "0.2.4",
"type": "module",
"scripts": {
"dev": "vite",
"build": "tsc && vite build",
"generate-data": "node scripts/generate-release-data.js",
"dev": "npm run generate-data && vite",
"build": "npm run generate-data && tsc && vite build",
"lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
"preview": "vite preview",
"tauri": "tauri",
"storybook": "storybook dev -p 6006",
"build-storybook": "storybook build"
},
"dependencies": {
"@fortawesome/fontawesome-svg-core": "^6.7.1",
"@fortawesome/free-brands-svg-icons": "^6.7.1",
"@fortawesome/react-fontawesome": "^0.2.2",
"@tailwindcss/container-queries": "^0.1.1",
"@tauri-apps/api": "^2.0.0",
"@tauri-apps/plugin-cli": "^2.0.0",
Expand Down Expand Up @@ -60,4 +64,4 @@
"@esbuild/darwin-arm64": "0.23.0",
"@rollup/rollup-darwin-arm64": "^4.18.1"
}
}
}
Binary file added public/zmk-mac-app-icon.webp
Binary file not shown.
29 changes: 29 additions & 0 deletions scripts/generate-release-data.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import fs from "fs/promises";
import path from "path";
import url from "url";

const __filename = url.fileURLToPath(import.meta.url);
const __dirname = path.resolve(__filename, "../..");

async function generateReleaseData() {
try {
const response = await fetch(
"https://api.github.com/repos/zmkfirmware/zmk-studio/releases/latest",
);
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}

const data = await response.json();
const dataFilePath = path.resolve(__dirname, "src", "data", "release-data.json");
await fs.mkdir(path.dirname(dataFilePath), { recursive: true });
await fs.writeFile(dataFilePath, JSON.stringify(data));

console.log("Release data generated successfully!");
} catch (error) {
console.error("Error generating release data:", error);
process.exit(1);
}
}

generateReleaseData();
2 changes: 1 addition & 1 deletion src/ConnectModal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ function noTransportsOptionsPrompt() {
</li>
<li>
Download our{" "}
<ExternalLink href="https://github.com/zmkfirmware/zmk-studio/releases">
<ExternalLink href="/download">
cross platform application
</ExternalLink>
.
Expand Down
Loading

0 comments on commit 2b88c5c

Please sign in to comment.