An Electron application built using Vite, Electron, React, and TypeScript.
- ⚡ Fast bundling and live reloading with electron-vite
- ⚛️ UI built with React 19 and Tailwind CSS
- 🧰 TypeScript support in both main and renderer processes
- 📦 Easy packaging with
electron-builder - 🔄 Auto-update enabled using
electron-updater - 📏 Linting and formatting with ESLint and Prettier
- 🚦 Type-checking for both web and node contexts
- 🔌 Modular router support with
@tanstack/react-router
npm installLaunch the application in development mode:
npm run devnpm run formatnpm run lintnpm run typecheckCreate a production build:
# Windows
npm run build:win
# macOS
npm run build:mac
# Linux
npm run build:linuxTo generate unpacked output only:
npm run build:unpackRun production build and trigger release process:
npm run release.
├── scripts/ # Utility scripts (e.g., version check)
├── src/ # Source code
│ ├── main/ # Electron main process
│ └── renderer/ # React renderer process
├── out/ # Compiled output directory
├── tsconfig.*.json # TypeScript configurations
├── vite.config.ts # Vite configuration
└── package.json # Project metadata and scripts
- Ensure your Node.js version is
^20.19.0or>=22.12.0. - Replace
app-namewith your actual application name wherever applicable.