Skip to content

Getting started

Build from source

The repository is a Bun workspace. Electron is the desktop runtime; Bun manages dependencies and project scripts.

Requirements

  • Bun
  • Git
  • Platform build tools required by Electron Builder for your target OS

Run the desktop app

git clone https://github.com/nonlooped/nativepi.git
cd nativepi
bun install
bun run dev

Run checks

bun run check
bun run test
bun run build

Run the narrowest test that covers your change. The desktop source is in apps/desktop; the public graphical contract is in packages/extension-api.

Build and package

bun run package -- --dir    # package without an installer
bun run package -- --win    # Windows installer
bun run package -- --mac    # macOS disk image
bun run package -- --linux  # Linux AppImage

Build installers on their target platform. Public releases are produced by the repository's release automation rather than by manually uploading local artifacts.