- TypeScript 64.9%
- HTML 17.1%
- JavaScript 11.3%
- Less 6.7%
| src | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitignore | ||
| .htmlhintrc.json | ||
| .stylelintrc.json | ||
| forge.config.js | ||
| package.json | ||
| README.md | ||
| tsconfig-checks.json | ||
| tsconfig-general.json | ||
| tsconfig-node.json | ||
| tsconfig-web.json | ||
| yarn.lock | ||
Test Electron app
A typical Electron test application that just runs. It can be compiled almost under Windows and Linux platform (deb, rpm, AppImage, .tar.gz)
Application preparation
To start this application, you need to do a little preparation:
- Install Node.js LTS (at the time of writing this documentation it is v18.14.0)
- Run the command
corepack enableto bring up the yarn command, you may need administrator rights. - In the folder with the project, run the command
yarn install, this will install all the necessary modules to work. - Compile the TypeScript files:
- Run
yarn run tsc_build_node - Run
yarn run tsc_build_web
- Run
- Compile the Less files:
- Run
yarn run less_build
- Run
Launching the program
To start the program, type the command yarn run start. This method is only suitable for testing, if you want to use the program later it is better to compile it.
Compiling the program
To compile the program for your operating system run: yarn run build. All compiled files are stored in the dist/ folder. The program can also be compiled for other operating systems, for example:
- Compilation for Windows:
yarn run build_win - Compilation for Linux:
yarn run build_linux <type>
Where <type> you must specify the file you want to output. For example, you could specify AppImage or rpm. Supported values are: AppImage, tar.gz, snap, rpm, deb. Example command:
yarn run build_linux AppImage
If you can't make up your mind, we recommend leaving this field blank. This will create a
ziparchive and a linux-unpacked/ folder with a binary to run the program.
In addition, different processor architectures are supported. By default it compiles according to your architecture, but you can change this behavior by adding an optional argument after the command. Compiling for x64, ia32, armv7l and arm64 architectures is supported. For example:
- Compilation under arm64 for Windows:
yarn run build_win --arm64 - Compilation under x64 for linux:
yarn run build_linux --x64 - And so on...
Note: compiling a program is not a quick thing, please be patient. Also during the compilation the program will download additional packages required for compilation.
Note 2: Packaged programs in .exe, .deb, .rpm and similar will take longer to run because it takes time to unpack and run them. Startup speed can be improved by running programs from the win-unpacked/ or linux-unpacked/ folders.