using-electron-packager.md

Using electron-packager

All builds produced by electron-packager can be found within the builds folder.

Building for all platforms

npm run build

Building for a specific platform

Platforms include darwin, mas, linux and win32.

# build for darwin (macOS)
npm run build:darwin

Cleaning

Delete all builds from builds.

npm run build:clean

A note for non-Windows users

If you are wanting to build for Windows with a custom icon using a non-Windows platform, you must have wine installed. More Info.

Default building configurations

Further customization can be made at config.js in accordance to electron-packager's options found here.

{
    // Target 'x64' architecture
    arch: 'x64',

    // Compress app using 'electron/asar'
    asar: true,

    // Directory of the app
    dir: path.join(__dirname, '../app'),

    // Set electron app icon
    // Change default icon in `app/icons`
    // File extensions are added based on platform
    //
    // If building for Linux, please read
    // https://github.com/electron-userland/electron-packager/blob/master/docs/api.md#icon
    icon: path.join(__dirname, '../app/icons/icon'),

    // Ignore files that would bloat final build size
    ignore: /\b(src|index\.ejs|icons)\b/,

    // `config.js` name
    name: config.name,

    // Save builds to `builds`
    out: path.join(__dirname, '../builds'),

    // Overwrite existing builds
    overwrite: true,

    // Environment variable that sets platform
    platform: process.env.PLATFORM_TARGET || 'all'
}