{"id":14977022,"url":"https://github.com/deluze/electron-vue-template","last_synced_at":"2025-05-16T10:08:09.626Z","repository":{"id":39801484,"uuid":"401534462","full_name":"Deluze/electron-vue-template","owner":"Deluze","description":"Simple Vue3 + Electron starter template in TypeScript. Includes ViteJS and Electron Builder","archived":false,"fork":false,"pushed_at":"2024-09-29T11:05:09.000Z","size":635,"stargazers_count":657,"open_issues_count":9,"forks_count":128,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-05-16T10:08:00.036Z","etag":null,"topics":["boilerplate","electron","electron-builder","hmr","hot-reload","template","typescript","vite","vitejs","vue","vuejs","vuejs3"],"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/Deluze.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2021-08-31T01:22:52.000Z","updated_at":"2025-05-16T09:22:27.000Z","dependencies_parsed_at":"2024-11-14T12:02:19.159Z","dependency_job_id":"563f586f-6fdb-4ea2-a565-20263dc616b5","html_url":"https://github.com/Deluze/electron-vue-template","commit_stats":{"total_commits":84,"total_committers":10,"mean_commits":8.4,"dds":0.4642857142857143,"last_synced_commit":"fceca5ec8ce9ac5a2922dddc1b732b7ba043a63a"},"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Deluze%2Felectron-vue-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Deluze%2Felectron-vue-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Deluze%2Felectron-vue-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Deluze%2Felectron-vue-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Deluze","download_url":"https://codeload.github.com/Deluze/electron-vue-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254509477,"owners_count":22082892,"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","electron","electron-builder","hmr","hot-reload","template","typescript","vite","vitejs","vue","vuejs","vuejs3"],"created_at":"2024-09-24T13:54:53.603Z","updated_at":"2025-05-16T10:08:04.610Z","avatar_url":"https://github.com/Deluze.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e \n\n# Electron Vue Template\n  \n\u003cimg width=\"794\" alt=\"image\" src=\"https://user-images.githubusercontent.com/32544586/222748627-ee10c9a6-70d2-4e21-b23f-001dd8ec7238.png\"\u003e\n\nA simple starter template for a **Vue3** + **Electron** TypeScript based application, including **ViteJS** and **Electron Builder**.\n\u003c/div\u003e\n\n## About\n\nThis template utilizes [ViteJS](https://vitejs.dev) for building and serving your (Vue powered) front-end process, it provides Hot Reloads (HMR) to make development fast and easy ⚡ \n\nBuilding the Electron (main) process is done with [Electron Builder](https://www.electron.build/), which makes your application easily distributable and supports cross-platform compilation 😎\n\n## Getting started\n\nClick the green **Use this template** button on top of the repository, and clone your own newly created repository.\n\n**Or..**\n\nClone this repository: `git clone git@github.com:Deluze/electron-vue-template.git`\n\n\n### Install dependencies ⏬\n\n```bash\nnpm install\n```\n\n### Start developing ⚒️\n\n```bash\nnpm run dev\n```\n\n## Additional Commands\n\n```bash\nnpm run dev # starts application with hot reload\nnpm run build # builds application, distributable files can be found in \"dist\" folder\n\n# OR\n\nnpm run build:win # uses windows as build target\nnpm run build:mac # uses mac as build target\nnpm run build:linux # uses linux as build target\n```\n\nOptional configuration options can be found in the [Electron Builder CLI docs](https://www.electron.build/cli.html).\n## Project Structure\n\n```bash\n- scripts/ # all the scripts used to build or serve your application, change as you like.\n- src/\n  - main/ # Main thread (Electron application source)\n  - renderer/ # Renderer thread (VueJS application source)\n```\n\n## Using static files\n\nIf you have any files that you want to copy over to the app directory after installation, you will need to add those files in your `src/main/static` directory.\n\nFiles in said directory are only accessible to the `main` process, similar to `src/renderer/assets` only being accessible to the `renderer` process. Besides that, the concept is the same as to what you're used to in your other front-end projects.\n\n#### Referencing static files from your main process\n\n```ts\n/* Assumes src/main/static/myFile.txt exists */\n\nimport {app} from 'electron';\nimport {join} from 'path';\nimport {readFileSync} from 'fs';\n\nconst path = join(app.getAppPath(), 'static', 'myFile.txt');\nconst buffer = readFileSync(path);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeluze%2Felectron-vue-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeluze%2Felectron-vue-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeluze%2Felectron-vue-template/lists"}