systembugtj / ember-electron

:battery: Build, test, compile and package awesome desktop apps with Ember Cli and Electron

Ember-Electron

An Ember addon to turn Ember apps into cross-platform desktop applications, taking care of development, tests, compilation, and installer creation.

• ember electron - Run app in Electron with live-reload server
• ember electron:test - Test the app using Electron
• ember electron:test --server - Test with Electron in development server mode
• ember electron:package - Create binaries (.app, .exe, etc)
• ember electron:make - Generate platform specific distributables (installers, distribution packages, etc)
• ember electron:build - Build out Ember app with Electron instrumentation (useful for optimizing multi-platform builds)
• ember electron:assemble - Assemble Electron application project (useful for debugging builds)

To see a real world example, check out Ghost Desktop.

Documentation

Basics

• Installation
• Usage
• Configuration
• Testing
• Packaging

Advanced Guides

• Upgrading from ember-electron 1.x to 2.x
• Testing on CI (Travis, AppVeyor, CircleCI, etc)
• Build pipeline

FAQ

• Common issues
• File structure
• Security concerns

Somethings missing? Contributions to our docs are welcome!

Support

Ember-Electron is a small open source project. Use GitHub Issues to report bugs and errors within the addon.

If you need help using the addon with your application, may we recommend the excellent Ember community? You can the various places to get help here. If you have questions regarding Electron, their Slack and forum will be helpful as well.

Development

ember-electron uses Semantic Release to automate the whole release process. In order to have a PR merged, please ensure that your PR follows the commit guidelines so that our robots can understand your change. This repository uses the conventional-changelog rules from the eslint repository.

Authors

Ember-Electron builds on prior work done by @brzpegasus (author of ember-cli-nwjs) and @joostdevries (author of ember-cli-remote-inspector). Our gratitude to both of them for their amazing work.

• Felix Rieseberg (@felixrieseberg)
• Aidan Nulman (@anulman)
• Florian Pichler (@pichfl)
• Ben Demboski (@bendemboski)
• ...and many other contributors