Exploring the Electron application framework
Universal Desktop
GitHub's Electron project brings the benefits of web programming to the realm of desktop applications.
If the boss orders a cross-platform desktop app for internal use, stressed IT staff often lack the time to get familiar with C++/Qt, Java, or Python and the associated application packaging. The Electron project [1] solves this problem by making a desktop app more like a web app. Electron combines Chromium [2] and Node.js [3] into a single run time, thus allowing the developer to build the application using the standard tools of web development, such as HTML, CSS, and JavaScript. The cross-platform nature of web development makes it quite easy to adapt your application to run on Windows, Mac OS, or Linux, and Electron even comes with tools that will package the app for the target OS.
Electron applications even update themselves automatically. Updates are retrieved from known sources, such as a GitHub repository, via an update server.
Electron began in 2013 as the framework for building GitHub's Atom text editor. GitHub open sourced Atom and Electron in 2014. Electron has an MIT license. Version 1.0.0 was released in 2016, and as of this year, it is available in Windows and OS X app stores as well as Linux repositories.
Bold Design
An Electron app works like a web application but in the reduced browser environment outlined in Figure 1. The Chromium components execute the application (top right in the picture). JavaScript libraries such as Bootstrap [4], React [5], Angular [6], or JQuery [7] contribute to the complete package.
Because the code within the application always executes using the Chromium run time, Electron avoids the possibility of problems arising from dissimilar browsers or browser versions. Developers also benefit from the debugging tools that come along with Chromium (Figure 2).
The main process manages the browser window. The Node API facilitates the connection to the desktop operating system. The developer can extend the Node environment by adding additional node packages.
Installing a Framework
Electron, the boilerplate project, and a set of tools used with Electron, including electron-packer
, electron-builder
, or electron-forge
, all take the form of node packages. Listing 1 installs Electron and all the tools a developer needs to pack the Electron apps onto a Ubuntu 16.04 node. Line 1 installs git and curl via the package manager; line 3 installs the latest version of Node.js. The necessary package list is created by a Bash script, which curl retrieves in line 2, under /etc/apt/sources.list.d/nodesource.list
, and then updates the list of available packages via apt-get.
Listing 1
Installing a Node
01 sudo apt-get install git curl 02 sudo curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash - 03 sudo apt-get install -y nodejs 04 npm install yarn 05 sudo su 06 # it also works without Yarn with: sudo npm -g install electron-forge 07 yarn add global electron-forge
After nodejs
in line 3, the script inserts the alternative node package manager, Yarn [8], one line later. With root privileges, Yarn then installs electron-forge
[9] (line 6).
Empty Stage
Electron has a number of boilerplate projects [10] that accelerate the development process by providing an minimal executable app out of the box. These projects internally use electron-packer
to create the Electron application and electron-builder
to packetize platform-specific formats. electron-forge
, which is installed in Listing 1, offers the best combination of both tools. It also comes from the workshop of the creators of electron-packer
and electron-builder
. The forge
shell command makes use of electron-forge
.
The life cycle of an app starts when the developer taps the forge init app
command into the keyboard. This command creates the app
project directory from Listing 2 in the style of a boilerplate project. As with any node app, the node_modules
directory stores all packages listed in the package.json
configuration file – in the latest version.
Listing 2
Boilerplate App
01 |- app 02 |- node_modules 03 |- package.json 04 |- src 05 |- yarn.lock
Finally, the src
directory stores the minimal web app, which the developer then converts step-by-step into the desired application.
Initially, the directory contains the index.html
HTML document and thus the entire web app, as well as the index.js
file. The programmer checks the development progress by switching to the app
project directory and entering the forge init start
command. Since a watch process like Angular is missing, a location.reload()
reloads the app via the debugging console.
Figure 2 shows the started app at run time. The debugging tool appears in the Chromium window on the right side of the screen by default. In the final version, the developer has to remember to disable the debugging tools in the main process code.
The yarn.lock
file from line 5 in Listing 2 remembers the currently stored packets under node_modules
. This mechanism makes it possible to reproduce node projects on other machines on a scale of 1 to 1.
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
News
-
Latest Cinnamon Desktop Releases with a Bold New Look
Just in time for the holidays, the developer of the Cinnamon desktop has shipped a new release to help spice up your eggnog with new features and a new look.
-
Armbian 24.11 Released with Expanded Hardware Support
If you've been waiting for Armbian to support OrangePi 5 Max and Radxa ROCK 5B+, the wait is over.
-
SUSE Renames Several Products for Better Name Recognition
SUSE has been a very powerful player in the European market, but it knows it must branch out to gain serious traction. Will a name change do the trick?
-
ESET Discovers New Linux Malware
WolfsBane is an all-in-one malware that has hit the Linux operating system and includes a dropper, a launcher, and a backdoor.
-
New Linux Kernel Patch Allows Forcing a CPU Mitigation
Even when CPU mitigations can consume precious CPU cycles, it might not be a bad idea to allow users to enable them, even if your machine isn't vulnerable.
-
Red Hat Enterprise Linux 9.5 Released
Notify your friends, loved ones, and colleagues that the latest version of RHEL is available with plenty of enhancements.
-
Linux Sees Massive Performance Increase from a Single Line of Code
With one line of code, Intel was able to increase the performance of the Linux kernel by 4,000 percent.
-
Fedora KDE Approved as an Official Spin
If you prefer the Plasma desktop environment and the Fedora distribution, you're in luck because there's now an official spin that is listed on the same level as the Fedora Workstation edition.
-
New Steam Client Ups the Ante for Linux
The latest release from Steam has some pretty cool tricks up its sleeve.
-
Gnome OS Transitioning Toward a General-Purpose Distro
If you're looking for the perfectly vanilla take on the Gnome desktop, Gnome OS might be for you.