grunt-electron-app-builder

Helps build electron based applications for mac, win and linux with grunt. It will download the prebuilt binaries for either the latest or a specific version, unpack them, and add your application source to the extracted distribution.

Getting Started

Install this grunt plugin with: npm install grunt-electron-app-builder

Then add this line to your project's gruntfile:

grunt.loadNpmTasks('grunt-electron-app-builder');

Example

module.exports = function(grunt) {
  grunt.initConfig({
    'build-electron-app': {
        options: {
            platforms: ["darwin", "win32"]
        }
    }
  });
  grunt.loadNpmTasks('grunt-electron-app-builder');
};

The "build-electron-app" task

Options

options.electron_version

Type: String Default value: most recent release Required: no

The version of electron you want to use (e.g., 'v0.32.0'). Here is a list of available releases. If not specified, it will query github for the latest release.

options.build_dir

Type: String Default value: build Required: no

Where application builds should be placed. Releases will be placed into a platform specific subdirectory. '[build_dir]'/'[platform]/'

options.cache_dir

Type: String Default value: cache Required: no

Where downloads of the pre-built binaries should be stored.

options.app_dir

Type: String Default value: app Required: no

Where application source is located. This will be copied to the app directory for each platform build.

options.platforms

Type: String Array Default value: [ 'HostPlatform' ] Required: no

The platforms to download and build packages for. Supported platforms are 'darwin', 'win32', 'linux32', and 'linux64' ('linux' works as well for backwards compatibility, and maps to linux32). If omitted, defaults to the host platform.

Note that building 'darwin' packages on a windows host is currently unsupported due to the format of the darwin electron zip, which includes symlinks.

To Do:

• Add support for further application customization (name, icon, etc)

License

Copyright (c) 2014 Chad Fawcett Licensed under the Apache 2.0 license.