README.md

Electron-Vite-ShadCN

A complete template to build beautiful desktop applications with Electron.

Libraries and Tools

• Core: Electron, Vite, SWC
• DX: TypeScript, Prettier, Zod, React Query
• UI: React, Tailwind CSS, Shadcn UI, i18next
• Testing: Jest, Playwright, React Testing Library
• Packaging: Electron Forge

Project Preferences

• Context isolation enabled
• Custom title bar
• Outfit font as default

Directory Structure

src/
  assets/
    fonts/
  components/
    ui/
  helpers/
    ipc/
  layout/
  lib/
  pages/
  stories/
  style/
  tests/

NPM Scripts

• dev: Run the app in dev mode
• package: Create platform-specific executable
• make: Build platform-specific distributables
• test: Run Jest and Playwright tests