apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-04-25 00:36:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
SurfSense/surfsense_desktop
History
CREDO23 080acf5e0a remove dead code: allPermissionsGranted, simulateCopy, pendingSuggestionText, updateSuggestionText
2026-04-03 20:16:23 +02:00
..
assets assets(desktop): generate .icns and .ico from source PNG 2026-03-18 19:56:55 +02:00
scripts remove uiohook-napi and keystroke monitoring 2026-04-03 16:10:52 +02:00
src remove dead code: allPermissionsGranted, simulateCopy, pendingSuggestionText, updateSuggestionText 2026-04-03 20:16:23 +02:00
.env refactor(desktop): replace resolve-env with build-time dotenv injection 2026-03-18 19:27:53 +02:00
.gitignore feat(desktop): add gitignore for build output 2026-03-17 16:39:36 +02:00
.npmrc feat: add native module support for desktop autocomplete 2026-04-02 13:18:20 +02:00
electron-builder.yml switch to on-demand permission requests and improve suggestion UX 2026-04-03 19:57:48 +02:00
package.json remove uiohook-napi and keystroke monitoring 2026-04-03 16:10:52 +02:00
pnpm-lock.yaml remove uiohook-napi and keystroke monitoring 2026-04-03 16:10:52 +02:00
pnpm-workspace.yaml chore: update pnpm workspace configuration to include root package 2026-03-18 13:20:37 -07:00
README.md docs(desktop): update README 2026-03-18 21:14:42 +02:00
tsconfig.json feat(desktop): add tsconfig for Electron TypeScript files 2026-03-17 16:18:44 +02:00

README.md

SurfSense Desktop

Electron wrapper around the SurfSense web app. Packages the Next.js standalone build into a native desktop application with OAuth support, deep linking, and system browser integration.

Prerequisites

  • Node.js 18+
  • pnpm 10+
  • The surfsense_web project dependencies installed (pnpm install in surfsense_web/)

Development

pnpm install
pnpm dev

This starts the Next.js dev server and Electron concurrently. Hot reload works — edit the web app and changes appear immediately.

Configuration

Two .env files control the build:

surfsense_web/.env — Next.js environment variables baked into the frontend at build time:

surfsense_desktop/.env — Electron-specific configuration:

Set these before building.

Build & Package

Step 1 — Build the Next.js standalone output:

cd ../surfsense_web
pnpm build

Step 2 — Compile Electron and prepare the standalone output:

cd ../surfsense_desktop
pnpm build

Step 3 — Package into a distributable:

pnpm dist:mac      # macOS (.dmg + .zip)
pnpm dist:win      # Windows (.exe)
pnpm dist:linux    # Linux (.deb + .AppImage)

Step 4 — Find the output:

ls release/