Git Product home page Git Product logo

electron-vue3-ts-quick-start's Introduction

Electron Vue3 Typescript Quick Start

Easy to use template for creating an app with Electron, Vue3, and Typescript

This is a vue3 application created with the vue-cli with Electron added on.

Table of Contents

Features

Scripts

  • npm run start: Starts the Electron app.
  • npm run build:dev: Builds the Vue app to the dist directory which is used by Electron to display the app.
  • npm run build:dev:watch: The same as above except it watches for and reloads on changes.
  • npm run build:prod: Creates a production ready build.
  • npm run test:unit: Runs the unit tests defined under test/unit.
  • npm run lint: Runs ESLint to check for issues.
  • npm run dist: Runs npm run build:prod and then calls electron-builder to package the Electron app.
  • npm run dist:mac: Runs npm run build:prod and then calls electron-builder to package the Electron app for OSX.
  • npm run dist:linux: Runs npm run build:prod and then calls electron-builder to package the Electron app for a Linux environment.
  • npm run dist:windows: Runs npm run build:prod and then calls electron-builder to package the Electron app for Windows.
  • npm run dist:all: Runs npm run build:prod and then calls electron-builder to package the Electron for OSX, Linux, and Windows.

Instructions

  1. Clone the repository
  2. Run npm install to install the dependencies needed.

To develop, you need to follow the steps below every time you begin working on it:

  1. First you want to run npm run build:dev:watch to build the dist directory and watch for changes to your Vue templates/components.
  2. Run npm run start to start Electron.

Now, with both of these running, whenever you make a change to the files Electron uses or the Vue files, the Electron window will update automatically.

Note: The electron files are not Typescript so that they can be reloaded with electron-reloader.

electron-vue3-ts-quick-start's People

Contributors

robertcorponoi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

electron-vue3-ts-quick-start's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.