@angular-guru/electron-builder

Electron Builder for the Angular CLI.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@angular-guru/electron-builder
Minified + gzip package size for @angular-guru/electron-builder in KB

Readme

Electron Builder for Angular CLI v8+

Overview

This is a builder for the Angular CLI that allows you to target an Electron environment, giving you access to all functions available to Electron such as file system access, which currently is not supported in the Angular CLI.

For example, you can do imports such as:

import { readFile } from 'fs';

It is important to note, is not schematics or anything that will help scaffold an Electron application for you. This is simply an extension to the Angular CLI build step to allow your Angular app to have full access to Electron's features without any awkward workarounds like message passing.

How To Use

The setup process is now incredibly simple. First install the package:

npm install @angular-guru/electron-builder --save-dev

Next, we need to update angular.json to use the electron-builder in two places:

"build": {
    "builder": "@angular-guru/electron-builder:build",
    ...
}
"serve": {
    "builder": "@angular-guru/electron-builder:dev-server",
    ...
}
"test": {
    "builder": "@angular-guru/electron-builder:karma",
    ...
}

You can find a basic example project using the Electron builder can be found here.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.