⚡️ An Electron starter kit with super powers. ⚡️
Switch branches/tags
Nothing to show
Clone or download
Alexandru Rosianu
Alexandru Rosianu Updates Electron to v0.31.1
Latest commit 2d13b4e Aug 31, 2015

README.md

Electron SuperKit Logo

Build status Dependency Status Join the chat at https://gitter.im/Aluxian/electron-superkit Get help on Codementor

⚡️ An Electron starter kit with super powers. ⚡️

Electron lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on io.js and Chromium and is used in the Atom editor.

Electron SuperKit uses Gulp to build, sign, pack and publish your awesome apps. All the Electron goodies are included:

  • native crash reporting
  • windows installer
  • debugging & profiling
  • native menus & notifications

Squirrel updates for OS X and Windows are NOT implemented. Instead, I created a custom updater that just compares the local package.json with a remote one on startup.

🔥 Extra:

  • dmg installer for OS X
  • deb & rpm packages for Linux
  • write ES6 JavaScript, ship ES5 code
  • write LESS stylesheets, ship CSS code
  • use AppVeyor to build Windows releases
  • task to publish releases to GitHub
  • live reload in development

Other ideas, not done yet:

  • sign the RPM
  • use a custom logger (bunyan, winston)

Note: The kit is not finished. I'm still working on polishing some features and making others work. Why not join me? I'm on Gitter :)

Getting started

Everything you need to know is should be in the wiki. I'm still working on it, so there might still be some missing pieces. If you need help with anything just ask and I'll write about it.

Get Started

Contributions 🙏

Contributions are welcome! For feature requests and bug reports please submit an issue or get in touch with me on Gitter or Twitter @aluxian.