@wixc3/engine-electron-commons

@wixc3/engine-electron

This is a cli tool, as well as a library which allows running engine applications in electron.

To run first install this package as a dependency npm i @wixc3/engine-electron

Then, to run your application in electron just run npx engine-electron start -f <my feature> -e <electron host environment>

If you want to build your application as an electron application just run npx engine-electron build -f <my feature> -e <electron host environment> This will create a "build" folder, in which the packed electron application will be located at

Start

Argument	Alias	Description	Is mandatory	Default value
--featureName	-f	The feature you want to run	Yes
--configName	-c	the name of the config you want your application to run with	No
--envName	-e	The name of the environment running in the electron-main process	Yes
--basePath		The path which is where to search the feature at	No	process.cwd()
--devtools		whether should open the browser window with devtools	No	false

Build

Argument	Alias	Description	Is mandatory	Default value
--featureName	-f	The feature you want to run	Yes
--configName	-c	the name of the config you want your application to run with	No
--envName	-e	The name of the environment running in the electron-main process	Yes
--basePath		The path which is where to search the feature at	No	process.cwd()
--tsConfigPath		Relative path to the tsconfig file with which the features should be built with	No	tsconfig.json
--outDir		the directory to which the bundled and transpiled code will be saved (relative to basePath)	No	dist
--electronBuilderConfigFileName		The name of the electrion builder config file (relative to basePath)	No	electron-build.json