Electron Bones

What you get

• React + TypeScript

  Typed UI and typed main process.

• Tailwind + shadcn/ui

  Styled and componentized from the first commit.

• IPC

  Main and renderer talk over a named channel list.

• Global context

  State flows from the main process down to React.

• Multi-window

  A main window and a child window, wired up.

• Notifications

  In-app and system-wide.

• Auto updater

  Switch it on after your first release.

• electron-store

  Settings that persist between launches.

• Context menu

  Right-click menus, ready to extend.

• Dark mode

  Follows the system.

• Keyboard shortcuts

  A shortcut manager, global shortcuts included.

• Menu bar and tray

  macOS, Windows and Linux menus plus a system tray icon.

• Logging

  Main-process logs you can read.

• Error handler

  Uncaught errors are caught and reported.

Quick start

1. 1. Clone the repo

   $ git clone https://github.com/shipkit-io/electron-bones.gitCopy

2. 2. Go into it

   $ cd electron-bonesCopy

3. 3. Install dependencies

   $ npm installCopy

4. 4. Start the dev server

   $ npm run startCopy

Source lives in src/main and src/renderer. To ship updates, uncomment the update function in src/main/auto-update.ts after your first release.