https://github.com/angular-guru/electron-builder
An Electron Build Target for Angular CLI
https://github.com/angular-guru/electron-builder
Last synced: about 1 year ago
JSON representation
An Electron Build Target for Angular CLI
- Host: GitHub
- URL: https://github.com/angular-guru/electron-builder
- Owner: angular-guru
- License: mit
- Created: 2018-08-15T11:48:30.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-05-07T15:25:34.000Z (about 5 years ago)
- Last Synced: 2025-03-31T08:44:00.788Z (about 1 year ago)
- Language: TypeScript
- Size: 793 KB
- Stars: 24
- Watchers: 2
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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:
```typescript
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:
```bash
npm install @angular-guru/electron-builder --save-dev
```
Next, we need to update `angular.json` to use the `electron-builder` in two places:
```json
"build": {
"builder": "@angular-guru/electron-builder:build",
...
}
```
```json
"serve": {
"builder": "@angular-guru/electron-builder:dev-server",
...
}
```
```json
"test": {
"builder": "@angular-guru/electron-builder:karma",
...
}
```
You can find a basic example project using the Electron builder can be [found here](https://github.com/angular-guru/electron-seed).