mefengl/electron-starter

electron-starter

Build upon amazing electron-vite framework.

Requirements

• bun

Addons

• orpc via MessagePort (Electron adapter)
• electron-log
• electron-conf
• @tanstack/router
• @tanstack/react-query v5
• shadcn/ui
• tailwindcss

dev:

• eslint-config
• bumpp: See Version Bumping

Notice

The automatic import of UI components with aliases is not functioning correctly. For instance, instead of getting import { Button } from "@renderer/components/ui/button";, you may receive import { Button } from "./components/ui/button";.

Currently, manual updating is required. If you have a solution to fix this issue, please submit an issue or pull request.

Recommended IDE Setup

• VSCode + ESLint

Project Setup

Install

bun install

Development

bun run dev

Version Bumping

Run bun run bump to bump version in cli.

Build

# For windows
bun run build:win

# For macOS
bun run build:mac

# For Linux
bun run build:linux