/electron-nuxt

⚡ An Electron & Nuxt.js / Vue.js quick start boilerplate with vue-cli scaffolding, electron-builder, unit/e2e testing, vue-devtools

Primary LanguageJavaScriptMIT LicenseMIT


electron-nuxt

Windows Build status Linux Build status OSX Build status

JavaScript Style Guide Code quality

Template version


Overview

The boilerplate for making electron applications built with vue / nuxt.

Things you'll find in this boilerplate:

  • Auto-updating for easy development *
  • ES6/ES7 compilation without any extra work *
  • Typescript support [WIP](only in renderer process for now)
  • Parallel code compilation
  • Installed latest vue-devtools
  • Ability to easily package your electron app using electron-builder
  • GitHub Action for releasing cross-platform apps (>1.6.0)
  • Configured ESLint (standard code style) with support for typescript linting**
  • Built-in support for CSS pre-processor: **
    • Sass (scss)
    • LESS
    • Stylus
  • Pre-installed UI components framework: **
  • Pre-installed icon set for offline usage: **

* available in renderer and main process
** customizable during vue-cli scaffolding

Getting Started

# Install vue-cli and scaffold boilerplate
npm install -g vue-cli
vue init michalzaq12/electron-nuxt <project-name>

# Install dependencies and run your app
cd <project-name>
yarn install
yarn dev

Take a look at the documentation. Here you will find useful information about configuration, project structure, and building your app

Sponsors

Electron-nuxt is an MIT licensed open source project and completely free to use. However, if you run a business and are using Electron-nuxt in a revenue-generating product, it makes business sense to sponsor project development.


RemSupp

Made with electron-nuxt