Introduction

Assignment work for the Compilers course at the Eszterházy Károly Catholic University, Hungary. Made by Dombi Tibor Dávid (HL5U4V).

Currently, runs with:

Angular v13.0.0
Electron v16.0.0

Getting Started

Clone this repository:

git clone https://github.com/dombidav/compilers-assignment.git

Install dependencies with npm (used by Electron renderer process):

npm install
# or
yarn 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

Install NodeJS dependencies with npm (used by Electron main process):

cd app

npm install
# or
yarn install

Why two package.json ? This project follow Electron Builder two package.json structure in order to optimize final bundle and be still able to use Angular ng add feature.

To build for development

in a terminal window -> npm start

Voilà! You can use the app in a local development environment with hot reload!

Note: You can disable "Developer Tools" by commenting win.webContents.openDevTools(); in app/main.ts.

Project structure

Folder	Description
app	Electron main process folder (NodeJS)
src	Electron renderer process folder (Web / Angular)

How to import 3rd party libraries

This project runs in both modes (web and electron). To make this work, you have to import your dependencies the right way. \

There are two kind of 3rd party libraries :

NodeJS's one - Uses NodeJS core module (crypto, fs, util...)
- I suggest you add this kind of 3rd party library in dependencies of both app/package.json and package.json (root folder) in order to make it work in both Electron's Main process (app folder) and Electron's Renderer process (src folder).

Please check providers/electron.service.ts to watch how conditional import of libraries has to be done when using NodeJS / 3rd party libraries in renderer context (i.e. Angular).

Web's one (like bootstrap, material, tailwind...)
- It has to be added in dependencies of package.json (root folder)

Add a dependency with ng-add

You may encounter some difficulties with ng-add because this project doesn't use the defaults @angular-builders.
For example you can find here how to install Angular-Material with ng-add.

Browser mode

Maybe you only want to execute the application in the browser with hot reload? Just run npm run ng:serve:web.

Included Commands

Command	Description
`npm run ng:serve`	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:build`	Builds your application and creates an app consumable based on your operating system

Your application is optimised. Only /dist folder and NodeJS dependencies are included in the final bundle.

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

Import your library in npm dependencies section of app/package.json with npm install --save XXXXX.
It will be loaded by electron during build phase and added to your final bundle.
Then use your library by importing it in app/main.ts file. Quite simple, isn't it?

E2E Testing

E2E Test scripts can be found in e2e folder.

Command	Description
`npm run e2e`	Execute end to end tests

Note: To make it work behind a proxy, you can add this proxy exception in your terminal
export {no_proxy,NO_PROXY}="127.0.0.1,localhost"

Debug with VsCode

VsCode debug configuration is available! In order to use it, you need the extension Debugger for Chrome.

Then set some breakpoints in your application's source code.

Finally, from VsCode press Ctrl+Shift+D and select Application Debug and press F5.

Please note that Hot reload is only available in Renderer process.

dombidav / compilers-assignment