electron-test

An Electron desktop starter built with Electron, Vite, React, TypeScript, Tailwind CSS, and shadcn/ui.

Recommended IDE Setup

• VSCode + ESLint + Prettier

Project Setup

Install

$ npm install

Development

$ npm run dev

Quality checks

$ npm run lint
$ npm run test
$ npm run build

Build

# For windows
$ npm run build:win

# For macOS
$ npm run build:mac

# For Linux
$ npm run build:linux

Project structure

• src/main - Electron main process and native persistence logic
• src/preload - typed bridge between renderer and main
• src/renderer/src - React UI, Tailwind styles, and shadcn/ui components
• src/shared - shared types and validation helpers used across process boundaries

First vertical slice

The starter includes a persisted Preferences dashboard:

• renderer edits local settings state
• preload exposes window.api.preferences
• main reads and writes preferences.json in Electron's user data folder

This gives the project a real end-to-end feature without weakening Electron security boundaries.