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.
electron-builderfully 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!
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. ^^^
The best app ever
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.
Built with Electron.
npm install
npm startnpm run releaseAfter Travis finishes building your app, open the release draft it created and click "Publish".