Skip to content

Latest commit

 

History

History
142 lines (90 loc) · 5.92 KB

README.md

File metadata and controls

142 lines (90 loc) · 5.92 KB
Raw

Nx Electron

Electron builders and schematics for Nrwl Nx platform.

licence npm version Downloads star this repo


Features

Nx Electron provides a set of power ups on Nx for developing cross platform desktop apps using Electron.

  • Schematics: Provides schematics for developing cross platform apps in a mono repo environment.
  • Typescript: Uses Typescript to help reduce errors, and create more structured code.
  • Obfuscation: Since Electron are used on the client machines, nx-electron obfuscates you code (and only it).
  • Minimization: Electron apps tend to be quite large, hence we use webpack to bundle, and minimize to code.
  • Live Update: Provides continuous live reload for your backend code.
  • Event Templates: Provides templates for common events like squirrel setup events, auto update events and IPC events.
  • Packaging: Packages your frontend and backend webpack bundles into single electron package.
  • Making: Makes your frontend and backend webpack bundles into single executable.

Getting Started

Prerequisite

This module is based on Nx, you will need to set up an Nx workspace before you can use nx-electron.

npx create-nx-workspace@13

You should also create a frontend project in you workspace (in any nx supported framework you like) for you electron app.

Installation

npm install -D nx-electron

Creating Nx Electron Application

nx g nx-electron:app <electron-app-name> --frontendProject=<frontend-app-name>

NOTE: You should add a frontend project to you workspace prior to invoking this command.

NOTE: On certain frontend platforms (such as Angular, React, etc...) it is important to change the baseHref field to "./", and use the hash strategy on the router in order for it to work well with electron. Further details can be found here.

Building Nx Electron Application

  • Run nx build <electron-app-name> to build your application.

Serving Nx Electron Application

  • Run nx serve <electron-app-name> to serve your application.

Packaging Nx Electron Application

  • Run nx run <electron-app-name>:package [--options] to package your application.
  • Or nx run <electron-app-name>:make --prepackgeOnly to package your application.

The options that can be passed are described here.

Making Nx Electron Application

  • Run nx run <electron-app-name>:make [--options] to make your application.

The options that can be passed are described here.

Configuring static packaging / making options

It is possible to configure all the packaging / making options in .\apps\<electron-app-name>\src\app\options\maker.options.json. For more information read this article. Notice: the option you define at this file will override the options you pass manually via the command line or choose via the angular console.

Migrating Nx Electron Application

To migrate automatically run ng update nx-electron@<version>. You can find detailed information in the following migration guides.

Testing Nx Electron Application

  • Run nx test <electron-app-name> to test your application.

Debugging Nx Electron Application

Minimal Project Structure

Regardless of what framework you chose, the resulting file tree will look like this:

<workspace name>/
├── apps/
│   ├── electron-app-name/
│   ├── frontend-app-name/
│   └── frontend-app-name-e2e/
├── libs/
├── tools/
├── nx.json
├── package.json
├── tsconfig.json
└── tslint.json

Support

If you're having any problem, please raise an issue on GitHub and we'll be happy to help.

Contribute

Versioning

This repository follows the semantic versioning rules while adhering to Nx and Angular version scheme. I.e. version 13.x of nx-electron will be compatible with version 13.y of NX.

Attribution

This project is highly inspired by (and dependent on) Nrwl Nx platform. Under the hood, we use Electron Builder to package and make electron application executables.


Author: Benny Megidish.