Initial Vynte Connect clients

2026-05-26 16:41:14 -05:00
commit 980535d682
35 changed files with 4958 additions and 0 deletions
@@ -0,0 +1,54 @@
+# Vynte Connect
+
+Vynte Connect is the branded client wrapper for the Vynte NetBird VPN at `https://vpn.vyntehome.com`.
+
+This source tree contains:
+
+- `apps/vynte-connect`: macOS 14 SwiftUI menu bar app.
+- `apps/vynte-connect-windows`: Windows Electron tray app.
+- `docs/vynte-connect-design-spec.md`: product and UI behavior notes.
+- `scripts/fetch-netbird-assets.mjs`: fetches the official NetBird runtime assets needed for packaging.
+
+The apps do not implement VPN networking themselves. They bundle and drive the official NetBird CLI, install/start the local NetBird helper service when needed, then poll `netbird status --json` until the tunnel is ready.
+
+## Prepare NetBird Assets
+
+Downloaded binaries are intentionally ignored by git. Fetch them before packaging:
+
+```bash
+node scripts/fetch-netbird-assets.mjs
+```
+
+To pin a version:
+
+```bash
+NETBIRD_VERSION=v0.71.4 node scripts/fetch-netbird-assets.mjs
+```
+
+## macOS
+
+```bash
+cd apps/vynte-connect
+swift build -c release
+./Scripts/package-zip.sh
+```
+
+Output:
+
+- `apps/vynte-connect/dist/Vynte Connect.app`
+- `apps/vynte-connect/dist/Vynte-Connect-macOS.zip`
+
+## Windows
+
+```bash
+cd apps/vynte-connect-windows
+npm install
+npm run package:win
+```
+
+Output:
+
+- `apps/vynte-connect-windows/dist/Vynte Connect-win32-x64/`
+- `apps/vynte-connect-windows/dist/Vynte-Connect-Windows-x64.zip`
+
+The Windows package is a portable x64 app bundle. It is not code-signed and does not stamp Windows executable metadata, so it can be built from macOS without Wine.