Make sure you have the following tools installed before running the project:
-
Node.js 24
nvm install 24
nvm use 24- node-gyp
npm install -g node-gyp- Visual Studio (not VS Code)
Before running the application for the first time, you must create a .env file.
- Copy the template file:
cp .env.template .env - Fill in the required environment variables in .env.
Initialize the development environment:
npm run init:dev
npm run clamav # optionalStart the application:
npm run startWhen running npm run package, Electron Builder may fail while extracting winCodeSign with an error similar to:
ERROR: Cannot create symbolic link: The client does not have a required privilege.
Enable Developer Mode in Windows Settings > System > For developers. Then clear Electron Builder's incomplete winCodeSign cache from PowerShell:
Remove-Item "$env:LOCALAPPDATA\electron-builder\Cache\winCodeSign" -Recurse -ForceRun npm run package again. Alternatively, run the terminal as Administrator.

