https://github.com/sindresorhus/generator-electron
Scaffold out an Electron app boilerplate
https://github.com/sindresorhus/generator-electron
Last synced: 3 months ago
JSON representation
Scaffold out an Electron app boilerplate
- Host: GitHub
- URL: https://github.com/sindresorhus/generator-electron
- Owner: sindresorhus
- License: mit
- Archived: true
- Created: 2015-04-23T11:28:40.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T11:37:24.000Z (12 months ago)
- Last Synced: 2025-01-28T20:23:26.966Z (3 months ago)
- Language: JavaScript
- Homepage: https://github.com/sindresorhus/electron-boilerplate
- Size: 793 KB
- Stars: 719
- Watchers: 15
- Forks: 58
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- 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
