Skip to content

ganeshaampuh/vue-electron-boilerplate

Repository files navigation

Desktop Vue Electron Boilerplate

A desktop application built with Vue.js and Electron.

Description

Desktop Vue Electron is a cross-platform desktop application framework that combines the power of Vue.js for the frontend and Electron for creating native applications.

Version

0.0.1

Author

Requirements

  • Node.js: >=v16.13
  • npm: >=8.1
  • bun: >=1.0.11

Scripts

  • build: Build the entire application
  • build:main: Build the main process
  • build:preload: Build the preload scripts
  • build:renderer: Build the renderer process
  • compile: Compile the application for production
  • test: Run all tests
  • test:e2e: Run end-to-end tests
  • test:main: Run tests for the main process
  • test:preload: Run tests for the preload scripts
  • test:renderer: Run tests for the renderer process
  • watch: Watch for changes during development
  • lint: Lint the codebase
  • typecheck: Run type checking
  • postinstall: Update Electron vendors
  • format: Format the codebase using Prettier

Dependencies

  • Vue.js (v2.7)
  • Electron
  • Vue Router
  • @mekari/pixel (optional)
  • electron-updater
  • @emotion/css

Development Dependencies

  • Vite
  • ESLint
  • Vitest
  • Playwright
  • electron-builder

License

This project is private and not open for public use or distribution.

Getting Started

  1. Clone the repository
  2. Install dependencies: npm install
  3. Run the development server: npm run watch
  4. Build for production: npm run compile

For more details on available scripts and their usage, refer to the "Scripts" section above.

About

Starter Kit for Desktop Apps with Electron + Vue

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published