Electron + NestJS + React + Vite template

Electron starter kit with multiple features

Features

• Electron
  • Electron builder
  • Electron store (json storage)
  • Auto updater
    • Update loading screen
  • Auto launch
  • NestJS
    • Standalone application
    • IPC handler, sender decorator
  • IPC preload script auto generate
• React
  • File system based router (nextjs pages router like)
• i18n
  • The default language is set by detecting which language you use

Overview framework & library

• App framework: electron
• App build tool: electron-builder
• App storage: electron-store
• App auto updater: electron-updater
• Bundle tool: vite + electron-vite
• Main process framework: nestjs
• Renderer process framework: react + typescript
• Code style: eslint + prettier + @trivago/prettier-plugin-sort-imports
• File system based router: react-router-dom v6 + custom (src/components/FileSystemRoutes)
• i18n: i18next + react-i18next

Architecture

Figma link

Github workflow

Figma link

Getting started

use template

• Create a repository from this template or fork this repository
• Create dev branch from main
• Set secret from github repository settings (Settings > Secrets and variables > Actions > New repository secret)
  • PERSONAL_TOKEN: Github personal access token (repo scope)

dev mode

pnpm dev

vite & electron build

pnpm build

known error

• %1 is not a valid Win32 application
• Github Action
  • Update package.json version
    • pathspec 'dev' did not match any file(s) known to git
      • DO: create dev branch from main