qrl-electrify - Formally (Meteor-)Electrify
Easily package your Meteor apps with Electron, and butter.
npm install -g qrl-electrifycd /your/meteor/appelectrify
Works on all Meteor's supported platforms.
$ electrify -hUsage: electrify [command] [options]Commands:run start meteor app within electrify contextbundle bundle meteor app at `.electrify` dirpackage bundle and package app to `--output` dirOptions:-h, --help output usage information-V, --version output the version number-i, --input <path> meteor app dir | default = .-o, --output <path> output dir | default = .electrify/.dist-s, --settings <path> meteor settings file | default = null-t, --temp <path> electrify temp folder | default = system temp folder-a, --arch <arch> arch to build for | default = current arch-p, --platform <platform> platform to build for | default = current platformExamples:# cd into meteor dir firstcd /your/meteor/appelectrifyelectrify runelectrify packageelectrify package -o /dist/direlectrify package -o /dist/dir -s file.jsonelectrify package -i /app/dir -o /dist/dir -s dev.jsonelectrify package -- <electron-packager-options># more info about electron packager options:# ~>
npm install -g qrl-electrify
For invoking Electron methods from Meteor, you'll also need to install the
arboleya:electrifymeteor package. For more info check Meteor x Electron integration.
cd /your/meteor/appelectrify package
The packaging process is done under the hood using
npm package. The following variables are automatically set:
--out-- comes from cli option [-o, --out]
--arch-- comes from system [current arch]
--platform-- comes from system [current platform]
--app-version-- comes from .electrify/package.json [current app version]
--electron-version-- comes from the used electron npm package
You can overwrite these default values and also set others by passing custom
arguments directly to
cd /your/meteor/appelectrify package -- --icon=/folder/x/img/icon.png --app-version=x.y.z
All the available options for
electron-packager can be found here:
Alternatively you can add an electronPackager object in package.json of the .electrify folder with options for the electron-packager. For the icon property it is possible to provide an object instead of string to define different icons for the different platforms. f.e.
The output app will match your current operational system and arch type.
- To get an OSX app, run it from a Osx machine.
- To get an Linux 32bit app, run it from a 32bit Linux machine.
- To get an Linux 64bit app, run it from a 64bit Linux machine.
- To get an Windows 32bit app, run it from a 32bit Windows machine.
- To get an Windows 64bit app, run it from a 64bit Windows machine.
Due to NodeJS native bindings of such libraries such as Fibers -- which are mandatory for Meteor, you'll need to have your Meteor app fully working on the desired platform before installing this plugin and packaging your app.
So, at this time, you cannot package your app in a cross-platform fashion from one single OS.
Perhaps you can live with it? :)
DO NOT use options to output for multiple arch/platforms at once, such as
--arch=all. It won't work, Electrify can bundle Meteor apps only for the platform you're running on.
NOTICE you can use the --arch and --platform of electrify BUT you won't get a working version for different platforms/archs out of the box. It's possible to make the generated application working with further steps that are not in scope of this project.
-i, --input- Meteor app folder, default is current directory (
-o, --output- Sets output folder for your packaged app, default is
-s, --settings- Sets path for Meteor settings file, this will be available inside your Meteor code both in development and after being packaged.
-t, --temp- Sets a temp folder other than the system temp folder to prevent moving errors (tmp and destination should be on the same partition)
-a, --arch- Sets a different arch for building NOTICE: only the current arch will work "out of the box"
-p, --platform- Sets a different platform for building NOTICE: only the current platform will work "out of the box"
You'll notice a new folder called
.electrify in your meteor app dir, its
structure will be like this:
/your/meteor/app ├── .electrify │ ├── .gitignore │ ├── electrify.json │ ├── index.js │ └── package.json ├── .meteor └── ...
This is a pure Electron project, so you can use the whole Electron API from JS
files in this folder. Also, you can install electron dependencies and store them
package.json file. Note that the
electrify package is itself a
See this folder as the
desktop layer for your Meteor app. Remember to check
index.js file, it constains the electrify start/stop usage.
electrify.json file will hold specific preferences for Electrify, such as
plugins and so on. It's still a WIP, but you can get around it.
For now there's only one option here:
Set it to true to preserve database between installs. It works by saving the mongo data dir inside user's data folder, instead of being self contained within the app folder (which gets deleted when new version is installed).
Let's see how one would be able to do a simple SplashScreen:
const app BrowserWindow = ;const electrify = __dirname;let window;let splash;app;// ....
Meteor x Electron integration
You can seamlessly call Electron methods from your Meteor's client/server code.
Define your Electron methods inside the
// `.electrify/index.js` fileelectrify;
Then, in your Meteor code (client and server), you can use the meteor-electrify-client to call these methods.
When upgrading to newer versions, it's important to know that:
Once these files exists on disk, they will not be overwritten.
As these files above will never be overwritten, in case of any API changes that needs adjustments, these will have to be made manually.
~> version matching
Always keep the same electrify version in your Meteor, and inside the
.electrify folder, as per specified in
Do not open issues, use the chat channel instead.
This is very young and active software, so make sure your are always up to date before opening an issue. Follow the released fixes through the HISTORY.md file.
If you find any problem, please open a meaningful issue describing in detail how to reproduce the problem, which platform/os/arch type you're using, as well as the version of Meteor and Electrify, and any other info you may find usefull.
The MIT License (MIT)
Copyright (c) 2017 Sebastian Große
Electrify originally created by Copyright (c) 2015 Anderson Arboleya