https://github.com/vanbess/sb-dev-electron-boilerplate

An updated (for 2024) boilerplate to kickstart creating an app with Electron. Based on a fork from sindresorhus/electron-boilerplate.
https://github.com/vanbess/sb-dev-electron-boilerplate

electron electron-app electronjs

Last synced: about 2 months ago
JSON representation

An updated (for 2024) boilerplate to kickstart creating an app with Electron. Based on a fork from sindresorhus/electron-boilerplate.

• Host: GitHub
• URL: https://github.com/vanbess/sb-dev-electron-boilerplate
• Owner: vanbess
• License: mit
• Created: 2024-07-14T17:56:44.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-14T18:01:43.000Z (6 months ago)
• Last Synced: 2024-10-18T21:01:29.510Z (3 months ago)
• Topics: electron, electron-app, electronjs
• Language: JavaScript
• Homepage:
• Size: 415 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# Silverback Dev Electron Boilerplate

> Boilerplate to kickstart creating an app with [Electron](https://github.com/electron/electron)

See [awesome-electron](https://github.com/sindresorhus/awesome-electron) for more useful Electron resources.

See [Caprine](https://github.com/sindresorhus/caprine) for a production app based on this boilerplate.

## Features

- [`electron-builder`](https://www.electron.build) fully set up to create cross-platform builds

- [Builds the app on CI](https://www.electron.build/multi-platform-build.html)

- [Silent auto-updates](https://www.electron.build/auto-update.html)

- App menu that adheres to the system user interface guidelines

- [Config handling](https://github.com/sindresorhus/electron-store)

- [Context menu](https://github.com/sindresorhus/electron-context-menu)

- [User-friendly handling of unhandled errors](https://github.com/sindresorhus/electron-unhandled)

- Easily publish new versions to GitHub Releases

- And much more!

## Getting started

**Click the green "Use this template" button at the top of this page to create your own repo based on this one, or open this repo in a codespace.**

---

**^^^ REMOVE EVERYTHING ABOVE THIS LINE. SETUP YOUR APP README USING THE STARTER TEXT BELOW. ^^^**

---

# App Name

> The best app ever

## Install

*macOS 10.13+, Linux, and Windows 7+ are supported (64-bit only).*

**macOS**

[**Download**](https://github.com/user/repo/releases/latest) the `.dmg` file.

**Linux**

[**Download**](https://github.com/user/repo/releases/latest) the `.AppImage` or `.deb` file.

*The AppImage needs to be [made executable](http://discourse.appimage.org/t/how-to-make-an-appimage-executable/80) after download.*

**Windows**

[**Download**](https://github.com/user/repo/releases/latest) the `.exe` file.

---

## Dev

Built with [Electron](https://electronjs.org).

### Run

```sh

npm install

npm start

```

### Publish

```sh

npm run release

```

After Travis finishes building your app, open the release draft it created and click "Publish".