Tools for using Go programs inside Electron apps
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
.npmignore
README.md
go-crosscompile.sh
package.json
yarn.lock

README.md

electron-go-picnic

Package that contains tools for using Go programs with Electron.

Originally extracted from my Who's Hacking product, which used my program gitmonitor to monitor live git repo changes across the system.

Functions

  • getAppPath, which gets the app path in development and production (when the app is unpacked from the archive).
  • getExecutableName which finds the correct executable for OS and CPU arch.
  • getGOARCH and getGOOS, wphich are used above.

Install

yarn add electron-go-picnic

Usage

  1. Cross-compile your Go programs for all platforms at once (Windows/Linux/macOS) using go-crosscompile.sh.
  2. Copy them to a directory in your Electron app. I advise vendor/.
  3. Make sure your executable is unpacked in production so it can be run. E.g. with electron-builder, modify package.json in the "build" section and add:
"asarUnpack": [
    "vendor/"
]
  1. Then in your Electron code:
const spawn = require('child_process').spawn;
import { getAppPath, getExecutableName } from 'electron-go-picnic';

let cmd = path.join(getAppPath(), `/vendor/', getExecutableName('gitmon'));
spawn(cmd)