Awesome
electron-boilerplate
Boilerplate to kickstart creating an app with Electron
See awesome-electron for more useful Electron resources.
See Caprine for a production app based on this boilerplate.
Features
electron-builder
fully set up to create cross-platform builds- Builds the app on CI
- Silent auto-updates
- App menu that adheres to the system user interface guidelines
- Config handling
- Context menu
- User-friendly handling of unhandled errors
- 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:
curl -fsSL https://github.com/sindresorhus/electron-boilerplate/archive/main.tar.gz | tar -xz --strip-components 1
There's also a Yeoman generator.
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 the .dmg
file.
Linux
Download the .AppImage
or .deb
file.
The AppImage needs to be made executable after download.
Windows
Download the .exe
file.
Dev
Built with Electron.
Run
npm install
npm start
Publish
npm run release
After Travis finishes building your app, open the release draft it created and click "Publish".