-
Notifications
You must be signed in to change notification settings - Fork 0
Installation
Sandeep Vattapparambil edited this page Aug 19, 2026
·
1 revision
- Node.js 20+
-
FFmpeg β bundled via
ffmpeg-static; falls back to systemffmpegif the bundled binary is unavailable
npm installThis installs all dependencies including ffmpeg-static and ffprobe-static, which download platform-specific binaries during their postinstall scripts.
# Start Vite dev server + tsc watch (no Electron window)
npm run dev
# Full dev environment with Electron window
npm run electron:dev
# Quick start (build then launch)
npm run dev:startnpm run dev starts two processes concurrently:
-
Vite β serves the React renderer on
http://localhost:5173with HMR -
tsc β watches and compiles the main process TypeScript to
dist/main/
npm run electron:dev waits for Vite to be ready, compiles both main and preload, then launches Electron with the --dev flag pointing at the Vite dev server URL. DevTools open automatically.
# Production build (renderer + main + preload)
npm run build
# Package for current platform (no installer)
npm run pack
# Create distributable installer
npm run dist| Script | Description |
|---|---|
npm run dev:renderer |
Vite dev server only |
npm run dev:main |
tsc -p tsconfig.main.json --watch |
npm run build:renderer |
Vite production build β outputs to dist/renderer/
|
npm run build:main |
tsc -p tsconfig.main.json β outputs to dist/main/
|
npm run build:preload |
tsc -p tsconfig.preload.json β outputs to dist/preload/
|
npm run build |
All three in sequence |
npm run start |
Launch compiled app from dist/ via electron .
|
npm run electron:dev |
Vite + Electron dev environment |
npm run dev:start |
Build then launch |
npm run format |
prettier --write on all src TypeScript/JSON |
npm run format:check |
prettier --check on all src TypeScript/JSON |
npm run pack |
Build + electron-builder --dir
|
npm run dist |
Build + electron-builder (NSIS/DMG/AppImage) |
| Layer | Technology |
|---|---|
| Framework | Electron v43 |
| UI | React 19, MUI 9 |
| State | Zustand 5 |
| Build | Vite, TypeScript |
| Testing | Vitest 4, Playwright |
| Media | FFmpeg (bundled via ffmpeg-static) |
| i18n | i18next (56 locales) |
Getting Started
Internals
Quality
Community