Source and Tools

Source files and tools

The source JavaScript is located in "src/appe/src", it is divided by sections to simplify understanding, the name of sections is intuitive.

• controller.js (Controller functions)
• index.js (Index with most important functions)
• layout.js (Handles layout functions)
• lockdown.js (Object.freeze)
• main.js ("main" functions)
• memory.js (Handles storage entries)
• os.js (Handles filesystem functions)
• start.js (Launcher functions)
• store.js (Handles persistent storage entries)
• utils.js (Utils functions)
• view.js ("view" functions)

 

Scripting tools

Scripts available in appe via npm run-script:

Task	Description
watch	build/watch all js and css assets
watch-js	build/watch all js assets
watch-css	build/watch all css assets
build	build all js and css assets
build-js	build all js assets
build-css	build all css assets
build-docs	build all documentation files, shortcut to php generate_docs.php
build-docs-html	transform wiki markdown documentation in html
build-docs-pdf	transform wiki markdown documentation in pdf
copy-demo	recursively copy all app assets in "demo" folder
copy-docs-recipes	recursively copy copy all documentation recipes files in "docs" folder
copy-electron	recursively copy all app files in "src/electron/src" folder

 

Electron (as an alternate execution)

To permits appe to run when the browser or the system do not allow direct execution, is used Electron, you can use the strategy that suits your needs.

The package configuration and the necessary dependencies are provided by Electron Forge, to install it npm install -g electron-forge .

After installing the necessary dependencies from the "src/electron" folder with the electron-forge start electron command, you can create distribution packages for operating systems with the electron-forge package command.

All the informations for package build are available on the website https://electronforge.io.