Skip to content
Convert dead link checking script to an electron app
TypeScript HTML JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
e2e
src
.editorconfig
.gitignore
.travis.yml
CHANGELOG.md
LICENSE.md
README.md
_config.yml
angular.json
browserslist
electron-builder.json
logo-angular.jpg
logo-electron.jpg
main.ts
package.json
postcss.config.js
postinstall-web.js
postinstall.js
tsconfig-serve.json
tsconfig.json
tsconfig.worker.json
tslint.json

README.md

Angular Logo Electron Logo

Travis Build Status Dependencies Status Make a pull request License

Watch on GitHub Star on GitHub Tweet

Introduction

Bootstrapped from the awesome boilerplate made by Maxime Gris. See the boilerplate here.

Currently runs with:

  • Angular v8.0.0
  • Electron v5.0.2
  • Electron Builder v20.41.0

The goal of this is create a user friendly version of the Dead Link Checker.

Getting Started

For development, it's as simple sa clone, npm i and npm start. Otherwise you should be able to download the files you program files that you want from relesaes.

To build for development

  • in a terminal window -> npm start

Voila! You can use your Angular + Electron app in a local development environment with hot reload !

The application code is managed by main.ts. In this sample, the app runs with a simple Angular App (http://localhost:4200) and an Electron window. The Angular component contains an example of Electron and NodeJS native lib import. You can disable "Developer Tools" by commenting win.webContents.openDevTools(); in main.ts.

Included Commands

Command Description
npm run ng:serve:web Execute the app in the browser
npm run build Build the app. Your built files are in the /dist folder.
npm run build:prod Build the app with Angular aot. Your built files are in the /dist folder.
npm run electron:local Builds your application and start electron
npm run electron:linux Builds your application and creates an app consumable on linux system
npm run electron:windows On a Windows OS, builds your application and creates an app consumable in windows 32/64 bit systems
npm run electron:mac On a MAC OS, builds your application and generates a .app file of your application that can be run on Mac

Your application is optimised. Only /dist folder and node dependencies are included in the executable.

You want to use a specific lib (like rxjs) in electron main thread ?

You can do this! Just by importing your library in npm dependencies (not devDependencies) with npm install --save. It will be loaded by electron during build phase and added to the final package. Then use your library by importing it in main.ts file. Easy no ?

Browser mode

Maybe you want to execute the application in the browser with hot reload ? You can do it with npm run ng:serve:web. Note that you can't use Electron or NodeJS native libraries in this case. Please check providers/electron.service.ts to watch how conditional import of electron/Native libraries is done.

You can’t perform that action at this time.