https://github.com/aluxian/electron-superkit

:zap: An Electron starter kit with super powers. :zap:
https://github.com/aluxian/electron-superkit

Last synced: about 2 months ago
JSON representation

:zap: An Electron starter kit with super powers. :zap:

• Host: GitHub
• URL: https://github.com/aluxian/electron-superkit
• Owner: aluxian
• License: mit
• Archived: true
• Created: 2015-07-06T10:07:25.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-10-30T14:42:52.000Z (almost 8 years ago)
• Last Synced: 2024-07-20T23:46:51.847Z (2 months ago)
• Language: CoffeeScript
• Size: 7.77 MB
• Stars: 213
• Watchers: 24
• Forks: 30
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![Electron SuperKit Logo](docs/logo.png)

[![Build status](https://ci.appveyor.com/api/projects/status/7u19ki1r7pofwr25/branch/deploy?svg=true)](https://ci.appveyor.com/project/Aluxian/electron-superkit/branch/deploy)

[![Dependency Status](https://david-dm.org/Aluxian/electron-superkit/status.svg)](https://david-dm.org/Aluxian/electron-superkit#info=dependencies)

[![Join the chat at https://gitter.im/Aluxian/electron-superkit](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Aluxian/electron-superkit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/aluxian)

:zap: *An Electron starter kit with super powers.* :zap:

[Electron](http://electron.atom.io/) 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](https://atom.io/) editor.

Electron SuperKit uses [Gulp](http://gulpjs.com/) 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.

:fire: 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](http://www.appveyor.com/) 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 :sparkles:

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](https://github.com/Aluxian/electron-superkit/wiki/Home)

## Contributions :pray:

Contributions are welcome! For feature requests and bug reports please [submit an issue](https://github.com/Aluxian/electron-superkit/issues) or get in touch with me on [Gitter](https://gitter.im/Aluxian/electron-superkit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) or Twitter [@aluxian](https://twitter.com/aluxian).