Skip to content

Latest commit

 

History

History
114 lines (83 loc) · 4.24 KB

README.md

File metadata and controls

114 lines (83 loc) · 4.24 KB
Raw

Electron Logo

Background

This is based on the starter kit CubikNeRubik/angular-electron-typeorm-starter.

Many thanks goes to JeB Barabanov for his article angular-cli-ng-test-with-jest-in-3-minutes-v2 and follow up answers to my comments.

This starter has a focus on the creation of a Windows executable with unit testing.

Quickstart

git clone https://github.com/AdditionAddict/angular-electron-typeorm-starter-plus-jest.git
npm install
npm start

Introduction

This is a start kit for easy launch of Electron, Angular 8 and TypeORM.

Plus Jest testing with tsconfig paths set up (ts-jest).

To see how I got from the starter to this setup

git log --all --decorate --oneline --graph

Currently runs with:

  • Angular v8.0.1
  • Electron v5.0.4
  • Electron Builder v20.44.2
  • Angular Material v8.0.1
  • TypeORM v0.2.18
  • SQLite v4.0.9
  • Jest v24.8.0

With this start kit, you can :

  • Run your app in a local development environment with Electron & Hot reload
  • Run your app in a production environment
  • Package your app into an executable file for Linux, Windows & Mac
  • Test the application with Jest

Getting Started

Clone this repository locally :

git clone https://github.com/AdditionAddict/angular-electron-typeorm-starter-plus-jest.git

Install dependencies with npm :

npm install

If you want to generate Angular components with Angular-cli , you MUST install @angular/cli in npm global context.
Please follow Angular-cli documentation if you had installed a previous version of angular-cli.

npm install -g @angular/cli

To build for development

  • in a terminal window -> npm start

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 which can edit data in database. The Angular component contains an example of Electron, TypeORM and NodeJS native lib import. If you need to add additional dependencies you shoud put it to extra-webpack.config.js. You can desactivate "Developer Tools" by commenting win.webContents.openDevTools(); in main.ts.

Included Commands

Command Description
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.

Known issues

  1. Browser mode. You can't use TypeORM in browser so it is not possible.If you need to run app in browser and don't need TypeORM you can use angular-electron for that.
  2. Windows Build. You cannot make build for windows if path to project folder contains spaces or not latin letters.
  3. Webpack mangles classnames and filename which TypeORM relies on - https://typeorm.io/#/faq/bundling-migration-files. For this reason in extra-webpack.config.js the following has been used.
module.exports = {
  // ... other Webpack configurations here
  optimization: {
    minimize: false,
  },
};

Alternatively a plugin could be used.