https://github.com/sindresorhus/electron-boilerplate

Boilerplate to kickstart creating an app with Electron
https://github.com/sindresorhus/electron-boilerplate

app boilerplate electron electron-boilerplate template template-repository

Last synced: 4 months ago
JSON representation

Boilerplate to kickstart creating an app with Electron

• Host: GitHub
• URL: https://github.com/sindresorhus/electron-boilerplate
• Owner: sindresorhus
• License: mit
• Archived: true
• Created: 2015-04-23T11:38:29.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2022-08-17T23:56:39.000Z (over 2 years ago)
• Last Synced: 2024-05-22T18:21:54.436Z (8 months ago)
• Topics: app, boilerplate, electron, electron-boilerplate, template, template-repository
• Language: JavaScript
• Homepage:
• Size: 745 KB
• Stars: 1,642
• Watchers: 34
• Forks: 172
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

• awesome-projects-boilerplates - Electron Boilerplate - node (JavaScript)
• awesome-seed - electron-boilerplate - Boilerplate to kickstart creating an app. (Seed List / Desktop)
• awesome-electron - electron-boilerplate - Boilerplate to kickstart creating an app - by [sindresorhus](http://github.com/sindresorhus). (Boilerplates / Samples)
• awesome-electron - electron-boilerplate - Boilerplate to kickstart creating an app.  (Boilerplates / Tools)
• awesome-electron-zh - electron-boilerplate - Boilerplate to kickstart creating an app - by [sindresorhus](http://github.com/sindresorhus). (Boilerplates / Samples)

README

        
# 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 "Use this template" button.**

Alternatively, create a new directory and then run:

```sh

curl -fsSL https://github.com/sindresorhus/electron-boilerplate/archive/main.tar.gz | tar -xz --strip-components 1

```

There's also a [Yeoman generator](https://github.com/sindresorhus/generator-electron).

---

**Remove everything from here and above**

---

# 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".