electron-nuxt icon indicating copy to clipboard operation
electron-nuxt copied to clipboard

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


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

  • NKNxVault: NKN desktop wallet (https://github.com/rule110-io/vault)
  • Reflex: Responsive web browser for developers (https://github.com/nwittwer/reflex)
  • BinaryBotPlayground: An Electron app for loading and running Binary bots (https://github.com/gabriellanzer/BinaryBotPlayground)
  • system-companion: Multi platform app for getting system information (https://github.com/romslf/system-companion)
  • NSMultiTools: Graphical interface to make life easier for Nintendo Switch hackers (https://github.com/MeatReed/NSMultiTools)
  • blue-burlap: CI/CD For Salesforce Deployments (https://github.com/fuzzybaird/blue-burlap)
  • cuesync: Synchronize cues between Algoriddim Djay, Serato DJ Lite/Pro and Virtual DJ (https://github.com/schneefux/cuesync)
  • VKGram: Messenger for VK that allows you to send custom stickers (https://github.com/PurpleHorrorRus/VKGram)
  • twitch-vip-controller: An app to help Twitch streamers automate VIP redemption and removal (https://github.com/kisuka/twitch-vip-controller)
  • Keyanu: Keyboard shortcut manager (https://github.com/pcktm/Keyanu)
  • JCloisterZone: PC implementation of Carcassonne board game (https://github.com/farin/JCloisterZone-Client)
  • StreamOverlay: An overlay for streamers with single display (https://github.com/PurpleHorrorRus/StreamOverlay)
  • screencast: Global Press Overlay of Keyboard and Mouse like VSCode Screencast (https://github.com/seonglae/screencast)
  • Enab App: Enab System - Manage Businesses & Connecting Them! (https://github.com/itourstory/EnabApp)
  • EARND: Personal Finance Manager (https://github.com/sanespi09/EARND-NUXT)
  • Intuiter: Global productivity app for anyone who use Windows (https://github.com/seonglae/intuiter)
  • Infrontier: Simple AWS S3 client (https://github.com/DiscreteTom/Infrontier)