Not sure what this app is even for? See here. There is plenty of documentation available in the app's built in FAQ, and if you need further help there are expert users to be found on the discord and the subreddit.
Check out the releases page for compiled downloads.
To compile this app, you'll need the latest Node.js and npm (if for any reason this doesn't work try downgrading to node 13.5.0 using nvm). Every script will need to be run from project directory.
Before running any scripts, dependencies must be installed using:
npm install
All script must be run using npm run command. For example, npm run watch:renderer.
| Script | Function |
|---|---|
postinstall |
Recompiles native apps to match Electron's NodeJS version if needed |
start |
Launches compiled app |
watch:main |
Compiles Electron app and watches for changes |
watch:renderer |
Compiles a renderer for an Electron app and watches for changes |
build:main |
Compiles Electron app in production mode |
build:renderer |
Compiles a renderer for an Electron app in production mode |
build:dist |
Runs build:main and build:renderer |
build:win |
Compiles an executable installer for Windows |
build:linux |
Compiles a deb package and AppImage for linux |
build:docker |
build:win and build:linux joined together |
build:mac |
Compiles a dmg package for MacOS |
Run watch:main (usually once since you rarely change anything in Electron app) and watch:renderer.
Each command creates separate webpack instance which will watch referenced files for changes and will recompile app.
App can be run using start script. After every recompile by watch:renderer, app can be refreshed using Ctrl + R, however watch:main requires need a restart.
Ctrl + Shift + I can be used to launch Chrome inspector once the app is running. This works even in the release version.
Scripts must be run in this order:
npm run build:dist
npm run build:win
Scripts must be run in this order:
npm run build:dist
npm run build:linux
Scripts must be run in this order:
npm run build:dist
npm run build:mac