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

Scaffold out an Electron app boilerplate
https://github.com/sindresorhus/generator-electron

Last synced: 4 months ago
JSON representation

Scaffold out an Electron app boilerplate

• Host: GitHub
• URL: https://github.com/sindresorhus/generator-electron
• Owner: sindresorhus
• License: mit
• Created: 2015-04-23T11:28:40.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2022-08-18T00:04:38.000Z (over 2 years ago)
• Last Synced: 2024-04-13T17:55:19.396Z (9 months ago)
• Language: JavaScript
• Homepage: https://github.com/sindresorhus/electron-boilerplate
• Size: 791 KB
• Stars: 718
• Watchers: 15
• Forks: 67
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license

Awesome Lists containing this project

• awesome-seed - generator-electron - Scaffold out an app boilerplate. (Seed List / Desktop)
• awesome-electron - generator-electron - Scaffold out an app boilerplate. (Boilerplates / Samples)
• awesome-electron - generator-electron - Scaffold out an app boilerplate.  (Boilerplates / Tools)
• awesome-electron-zh - generator-electron - Scaffold out an app boilerplate. (Boilerplates / Samples)

README

        
# generator-electron 

> Scaffold out an Electron app

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 Travis](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!

## Install

```sh

npm install --global yo generator-electron

```

## Usage

With [yo](https://github.com/yeoman/yo):

```

$ yo electron

```

## Related

- [electron-boilerplate](https://github.com/sindresorhus/electron-boilerplate) - Electron app boilerplate