electron-boilerplate

A boilerplate application with Vue.js framework for Electron runtime.

Usage

Click the "Use this template" button.

Alternatively, create a new directory and then run:

$ mkdir my-project
$ cd my-project
$ curl -fsSL https://github.com/zce/electron-boilerplate/archive/master.tar.gz | tar -xz --strip-components 1

Or git clone:

$ git clone https://github.com/zce/electron-boilerplate.git --depth 1 my-project

Active Travis CI

Create new GitHub token with public_repo scope: https://github.com/settings/tokens，Set in travis-ci.org dashboard

GH_TOKEN=<your github token>

After Travis finishes building your app, open the release draft it created and click "Publish".

Features

• electron-builder fully set up to create cross-platform builds
• Builds the app on Travis
• Silent auto-updates
• Custom title bar
• State & Settings store
• User-friendly handling of unhandled errors
• Useful utilities for Electron apps and modules
• App menu that adheres to the system user interface guidelines
• Easily publish new versions to GitHub Releases
• And much more!

Todos

• [ ] Something

dependencies

• source-map-support

devDependencies

• @commitlint/cli
• @commitlint/config-conventional
• @vue/eslint-config-standard
• @vue/eslint-config-typescript
• commitizen
• cz-conventional-changelog
• electron
• electron-builder
• electron-webpack
• eslint
• eslint-friendly-formatter
• eslint-loader
• eslint-plugin-vue
• fork-ts-checker-webpack-plugin
• husky
• lint-staged
• node-sass
• prettier
• sass-loader
• standard-version
• ts-loader
• typescript
• vue
• vue-html-loader
• vue-i18n
• vue-loader
• vue-property-decorator
• vue-router
• vue-style-loader
• vue-template-compiler
• vuex
• vuex-class
• webpack
• webpack-build-notifier

References

Helpful links

• https://github.com/electron/electron-quick-start/blob/master/main.js
• https://github.com/mawie81/electron-window-state
• https://github.com/sindresorhus/electron-boilerplate
• https://github.com/sindresorhus/electron-util
• https://github.com/sindresorhus/electron-store
• https://github.com/sindresorhus/electron-context-menu
• https://github.com/sindresorhus/electron-dl
• https://github.com/sindresorhus/electron-debug
• https://github.com/sindresorhus/electron-unhandled
• https://github.com/sindresorhus/electron-reloader
• https://github.com/sindresorhus/electron-serve
• https://github.com/iffy/electron-updater-example

Contributing

1. Fork it on GitHub!
2. Clone the fork to your own machine.
3. Checkout your feature branch: git checkout -b my-awesome-feature
4. Commit your changes to your own branch: git commit -am 'Add some feature'
5. Push your work back up to your fork: git push -u origin my-awesome-feature
6. Submit a Pull Request so that we can review your changes.

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

License

MIT © 汪磊