feat: add Desktop release for macOS, Windows & Linux (#130)

Closes #64 


![image](https://github.com/user-attachments/assets/6f971403-5ac0-4355-9066-eaf482efbe87)

![image](https://github.com/user-attachments/assets/ca4f62c4-c019-4acd-b229-d88133a68ac2)

---------

Co-authored-by: Fernando Maclen <[email protected]>

Author: GregoMac1

.github/workflows/publish.yml .github/workflows/release.yml

@@ -1,13 +1,13 @@
-name: Publish Docker image to container registry
+name: Release
 
 on:
   push:
     branches:
       - main
 
 jobs:
-  release:
-    name: Semantic release
+  versioning:
+    name: Versioning
     runs-on: ubuntu-latest
     outputs:
       new_release_published: ${{ steps.semantic.outputs.new_release_published }}
@@ -30,16 +30,16 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
 
   cloudflare:
-    name: CloudFlare Pages
-    needs: release
-    if: ${{ needs.release.outputs.new_release_published == 'true' }}
+    name: Live demo
+    needs: versioning
+    if: ${{ needs.versioning.outputs.new_release_published == 'true' }}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
       - name: Update app version in package.json
-        run: node .github/workflows/publish/update-package-json.cjs ${{ needs.release.outputs.new_release_version }}
+        run: node .github/workflows/publish/update-package-json.cjs ${{ needs.versioning.outputs.new_release_version }}
 
       - name: Set up Node.js
         uses: actions/setup-node@v4
@@ -55,9 +55,35 @@ jobs:
           accountId: ${{ secrets.CF_ACCOUNT_ID }}
           command: pages publish .svelte-kit/cloudflare --project-name hollama
 
+  electron:
+    needs: versioning
+    if: ${{ needs.versioning.outputs.new_release_published == 'true' }}
+
+    name: Desktop app (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [macos-13, ubuntu-latest, windows-latest] # macos-13 is the lastest one on x86
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+
+      - name: Update app version in package.json
+        run: node .github/workflows/publish/update-package-json.cjs ${{ needs.versioning.outputs.new_release_version }}
+
+      - name: Install Electron & SvelteKit's dependencies
+        run: npm ci
+
+      - name: Build & release Electron app
+        run: npm run electron:build
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
+
   docker:
-    needs: release
-    if: ${{ needs.release.outputs.new_release_published == 'true' }}
+    needs: versioning
+    if: ${{ needs.versioning.outputs.new_release_published == 'true' }}
 
     name: Docker image
     runs-on: ubuntu-latest
@@ -66,7 +92,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Update app version in package.json
-        run: node .github/workflows/publish/update-package-json.cjs ${{ needs.release.outputs.new_release_version }}
+        run: node .github/workflows/publish/update-package-json.cjs ${{ needs.versioning.outputs.new_release_version }}
 
       - name: Build & publish
         uses: mr-smithers-excellent/docker-build-push@v6
@@ -75,6 +101,6 @@ jobs:
           registry: ghcr.io
           multiPlatform: true
           platform: linux/amd64,linux/arm64
-          tags: latest, ${{ needs.release.outputs.new_release_version }}
+          tags: latest, ${{ needs.versioning.outputs.new_release_version }}
           username: ${{ secrets.GH_REGISTRY_USERNAME }}
           password: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 node_modules
 /build
+/dist
 /.svelte-kit
 /package
 .env

CONTRIBUTING.md

@@ -15,8 +15,9 @@ Hollama is a static site built with:
 - TypeScript
 - Svelte & SvelteKit
 - Vite
-- Playwright
 - Tailwind CSS
+- Playwright
+- Electron
 
 Install dependencies with `npm install`, start a development server:
 
@@ -25,6 +26,9 @@ npm run dev
 
 # or start the server and open the app in a new browser tab
 npm run dev -- --open
+
+# run the app with Electron
+npm run electron
 ```
 
 ## Building
@@ -33,6 +37,9 @@ To create a production version of Hollama:
 
 ```bash
 npm run build
+
+# or package with Electron
+npm run electron:build
 ```
 
 You can preview the production build with `npm run preview`.

README.md

@@ -19,7 +19,7 @@ A minimal web-UI for talking to [Ollama](https://github.com/jmorganca/ollama/) s
 - ⚡️ [Live demo](https://hollama.fernando.is)
   - _No sign-up required_
 - 🐳 [Self-hosting](#self-host-docker) with Docker
-- 🖥️ Download for [macOS, Windows & Linux](https://github.com/fmaclen/hollama/releases) _(Coming soon)_
+- 🖥️ Download for [macOS, Windows & Linux](https://github.com/fmaclen/hollama/releases)
 - 🐞 [Contribute](CONTRIBUTING.md)
 
 > ![session](tests/docs.test.ts-snapshots/session.png)

electron-builder.yml

@@ -0,0 +1,30 @@
+appId: com.hollama.desktop
+productName: Hollama
+artifactName: ${productName}_${version}-${os}-${arch}.${ext}
+
+files:
+  - build/**/*
+  - electron/**/*
+
+mac:
+  category: public.app-category.developer-tools
+  icon: electron/resources/icons/mac/icon.icns
+  hardenedRuntime: true
+  target: dmg
+
+win:
+  target: nsis
+  icon: electron/resources/icons/win/icon.ico
+
+nsis:
+  oneClick: false
+  allowToChangeInstallationDirectory: true
+
+linux:
+  target: tar.gz
+  icon: electron/resources/icons/png/1024x1024.png
+
+publish:
+  provider: github
+  releaseType: release
+  vPrefixedTagName: false

electron/main.js

@@ -0,0 +1,84 @@
+import net from 'net';
+import { join } from 'path';
+import { app, BrowserWindow, utilityProcess, dialog } from 'electron';
+
+// Vite default dev & production ports
+const hollamaPort = app.isPackaged ? '4173' : '5173';
+const HOLLAMA_HOST = '127.0.0.1';
+
+function createWindow() {
+	const mainWindow = new BrowserWindow({
+		width: 1280,
+		height: 800,
+		minWidth: 400,
+		minHeight: 640
+	});
+
+	mainWindow.menuBarVisible = false; // Windows: hides the menu bar
+	mainWindow.loadURL(`http://${HOLLAMA_HOST}:${hollamaPort}`);
+}
+
+function checkServerAvailability(port) {
+	const MAX_RETRIES = 10;
+	const RETRY_INTERVAL_IN_MS = 1000;
+
+	return new Promise((resolve, reject) => {
+		let retries = 0;
+
+		function tryConnection() {
+			const socket = new net.Socket();
+
+			const onError = () => {
+				socket.destroy();
+
+				if (retries >= MAX_RETRIES) {
+					reject(new Error(`Couldn't connect to Hollama server after ${MAX_RETRIES} attempts`));
+				} else {
+					retries++;
+					setTimeout(tryConnection, RETRY_INTERVAL_IN_MS);
+				}
+			};
+
+			socket.setTimeout(1000);
+			socket.once('error', onError);
+			socket.once('timeout', onError);
+
+			socket.connect(port, HOLLAMA_HOST, () => {
+				socket.destroy();
+				resolve();
+			});
+		}
+
+		tryConnection();
+	});
+}
+
+app
+	.whenReady()
+	.then(async () => {
+		if (app.isPackaged) {
+			utilityProcess.fork(join(app.getAppPath(), 'build', 'index.js'), {
+				env: { ...process.env, PORT: hollamaPort }
+			});
+		} else {
+			console.warn('##### Running Electron in development mode');
+			console.log('##### Run `npm run dev` to start the Hollama server separately');
+		}
+
+		await checkServerAvailability(parseInt(hollamaPort));
+		createWindow();
+	})
+	.catch((error) => {
+		dialog.showErrorBox('Error', error.message);
+		app.quit();
+	});
+
+// Quit when all windows are closed, except on macOS.
+app.on('window-all-closed', function () {
+	if (process.platform !== 'darwin') app.quit();
+});
+
+// macOS: Open a window if none are open
+app.on('activate', function () {
+	if (BrowserWindow.getAllWindows().length === 0) createWindow();
+});