{"id":15198649,"url":"https://github.com/mubaidr/vue-electron-template","last_synced_at":"2025-04-05T11:10:56.086Z","repository":{"id":37798410,"uuid":"131605470","full_name":"mubaidr/vue-electron-template","owner":"mubaidr","description":"An Electron \u0026 Vue.js template with Hot-reloading enabled and common Vue plugins, dev, debug and build scripts configured.","archived":false,"fork":false,"pushed_at":"2024-09-01T11:32:06.000Z","size":8886,"stargazers_count":319,"open_issues_count":42,"forks_count":54,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-29T10:06:53.988Z","etag":null,"topics":["boilerplate","bulma","electron","electron-vue","electronjs","rollup","rollup-js","starter","starter-template","vue","webpack","webpack4"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mubaidr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"mubaidr","patreon":"mubaidr","open_collective":"mubaidr","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":"mubaidr","otechie":null,"custom":null}},"created_at":"2018-04-30T14:24:59.000Z","updated_at":"2025-03-24T00:47:07.000Z","dependencies_parsed_at":"2024-12-01T03:05:14.590Z","dependency_job_id":"5059dc0e-5e8c-4629-9180-4cc83fd015c5","html_url":"https://github.com/mubaidr/vue-electron-template","commit_stats":{"total_commits":633,"total_committers":9,"mean_commits":70.33333333333333,"dds":0.5387045813586098,"last_synced_commit":"7e3dac8a6b046345a59bac81fc0ff46763d562b3"},"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mubaidr%2Fvue-electron-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mubaidr%2Fvue-electron-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mubaidr%2Fvue-electron-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mubaidr%2Fvue-electron-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mubaidr","download_url":"https://codeload.github.com/mubaidr/vue-electron-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247325693,"owners_count":20920714,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","bulma","electron","electron-vue","electronjs","rollup","rollup-js","starter","starter-template","vue","webpack","webpack4"],"created_at":"2024-09-28T01:23:37.553Z","updated_at":"2025-04-05T11:10:56.053Z","avatar_url":"https://github.com/mubaidr.png","language":"JavaScript","funding_links":["https://github.com/sponsors/mubaidr","https://patreon.com/mubaidr","https://opencollective.com/mubaidr","https://issuehunt.io/r/mubaidr"],"categories":["脚手架","Components \u0026 Libraries","Scaffold","Scaffold [🔝](#readme)"],"sub_categories":["电子","Scaffold","Electron"],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"./_icons/logotype1blue.png\"\u003e\u003c/p\u003e\n\n# Vue-Electron-Template\n\n[![Build Status](https://travis-ci.org/mubaidr/vue-electron-template.svg?branch=master)](https://travis-ci.org/mubaidr/vue-electron-template)\n[![Build status](https://ci.appveyor.com/api/projects/status/cjua6pdhjp9rqa1o?svg=true)](https://ci.appveyor.com/project/mubaidr/vue-electron-template)\n[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)\n\nTemplate for building desktop applications using [Electronjs](https://electronjs.org) and [Vue.js](https://vuejs.org)\n\n## NOTICE\n\n[Vue3 Support](https://github.com/mubaidr/vue-electron-template/issues/907)\n\n## Overview\n\nThis template takes advantage of `webpack-5` with `vue-loader`, `electron-builder`, and some of the most used plugins like `vue-router`, `vuex` and so much more to provide an easy to use development (with vscode debugging) enviroment with hot module replacement.\n\n### Features\n\n- [Bulma-Fluent](https://mubaidr.github.io/bulma-fluent/), a theme suitable for desktop application based on [Bulma](https://bulma.io/)\n- [vue-router](https://github.com/vuejs/vue-router)\n- [vuex](https://github.com/vuejs/vuex)\n- [vue-electron](https://github.com/SimulatedGREG/vue-electron)\n- [material-design-icons](http://google.github.io/material-design-icons/) installed\n- Some built-in animaitons [animations.scss](src\\renderer\\assets\\style\\animations.scss)\n- `SCSS`/`SASS` support with [vue-loader](https://github.com/vuejs/vue-loader/) (removes unused css/styles during build)\n- `Typescript` support (for `Vuejs` as well)\n- Worker scripts (to perform CPU-intensive operations), to use with nodejs `child_process` module. [Sample Worker File](src\\utilities\\workerSample.ts)\n- Easily package your electron app using [electron-builder](https://github.com/electron-userland/electron-builder)\n- `vue-devtools` installed\n- `DEV`, `DEBUG` \u0026 `BUILD` NPM scripts\n- `Babel` configured\n- `ESLint` configured\n- `vscode` debug config for renderer process debugging\n- Process restarting when working in main process \u0026 hot module replacement for renderer\n- Generates web/browser build in the `dist/web` directory too\n- `--debug` paramter to enable dev tools in production build executeable\n\n### Screenshot\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"./screenshot.png\"\u003e\u003c/p\u003e\n\n### Getting Started\n\nClone this repository, install dependencies and run using either `dev`, `debug` or `build` command.\n\n```bash\n# Clone this repository\ngit clone https://github.com/mubaidr/vue-electron\n\n# change directory to cloned path\ncd vue-electron\n\n# Install dependencies\nnpm install\n\n# Run in `debug` mode, to debug app using VSCODE\nnpm run debug\n\n# Run in `dev` mode\nnpm run dev\n\n# Build installer for this app\nnpm run build\n```\n\n### Project structure\n\n`src/main` contains electron main script.\n\n`src/renderer` contains vue-js application.\n\n`src/utilities/workerSample.ts` a sample worker script.\n\n#### Credits\n\nAll credits to authors of packages and tools used in the project.\n\n\\* This template is inspired by [electron-vue](https://github.com/SimulatedGREG/electron-vue)\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/jbeguna04\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/35353768?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJibbie R. Eguna\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#design-jbeguna04\" title=\"Design\"\u003e🎨\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/eiurur\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/4101830?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eeiurur\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/mubaidr/vue-electron-template/commits?author=eiurur\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmubaidr%2Fvue-electron-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmubaidr%2Fvue-electron-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmubaidr%2Fvue-electron-template/lists"}