{"id":14967715,"url":"https://github.com/bdero/electron-vue-typescript-starter","last_synced_at":"2025-09-15T12:31:50.187Z","repository":{"id":147906856,"uuid":"103867388","full_name":"bdero/electron-vue-typescript-starter","owner":"bdero","description":":nut_and_bolt: An Electron starter that supports VueJS + TypeScript.","archived":false,"fork":false,"pushed_at":"2020-07-07T02:29:49.000Z","size":14,"stargazers_count":79,"open_issues_count":6,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-07T10:25:03.504Z","etag":null,"topics":["electron","electron-compile","electron-forge","electron-packager","es7","jade","scss","typescript","visual-studio-code","vue"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/bdero.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":"2017-09-17T22:43:33.000Z","updated_at":"2023-07-07T12:14:01.000Z","dependencies_parsed_at":"2023-05-27T21:30:08.947Z","dependency_job_id":null,"html_url":"https://github.com/bdero/electron-vue-typescript-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/bdero/electron-vue-typescript-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bdero%2Felectron-vue-typescript-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bdero%2Felectron-vue-typescript-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bdero%2Felectron-vue-typescript-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bdero%2Felectron-vue-typescript-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bdero","download_url":"https://codeload.github.com/bdero/electron-vue-typescript-starter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bdero%2Felectron-vue-typescript-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275259148,"owners_count":25433372,"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","status":"online","status_checked_at":"2025-09-15T02:00:09.272Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["electron","electron-compile","electron-forge","electron-packager","es7","jade","scss","typescript","visual-studio-code","vue"],"created_at":"2024-09-24T13:38:30.317Z","updated_at":"2025-09-15T12:31:49.847Z","avatar_url":"https://github.com/bdero.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# :nut_and_bolt: Electron-Vue-TypeScript Starter\n\nThe Electron Shell starter that'll have you saying \"kids these days\" faster than you can type `npm start`.\n\n## **WARNING:** Electron Compile (one of the core dependencies of this starter) is no longer being actively maintained. Please consider starting your project using [Electron Forge](https://www.electronforge.io/) directly instead!\n\n### Features\n\n* All programming/style/markup languages supported by [Electron Compile](https://github.com/electron/electron-compile#electron-compile):\n  * **Programming:** TypeScript, ES6, ES7, CoffeeScript, GraphQL\n  * **Style:** Less, Sass, Stylus\n  * **Markup/other:** Jade, and Vue\n* In particular, TypeScript is tuned to be as strict as possible.\n* Good TypeScript code completion in [VS Code](https://code.visualstudio.com/)! (There were some quirks to work out here)\n* Packaging for distribution with [Electron Forge](https://github.com/electron-userland/electron-forge):\n  * Run `npm run make` to generate distributable packages.\n  * Configure forge by modifying `forge.config.js`.\n* Hot reloading of everything (courtesy of [Electron Compile](https://github.com/electron/electron-compile))\n* VueJS devtools.\n\n### How to use\n\nSimply fork or [download](https://github.com/bdero/electron-vue-typescript-starter/archive/master.zip) this repo, and start hacking away! Before beginning any work, install all dependencies by running `npm install`.\n\nAvailable commands:\n* `npm start`: Runs the application with Electron in development mode. Hot reloading as well as the Vue devtools are enabled in this mode.\n* `npm run make`: Builds distributable app packages using [Electron Forge](https://github.com/electron-userland/electron-forge), placing the results in the **out** directory. Note that this will only build packages compatible with the host system running the command; running the build on **macOS** won't produce **GNU/Linux** packages, for example.\n* `npm run lint`: Runs `tslint` over all TypeScript files.\n\n### What might I want to customize first?\n\n* This [readme](README.md)\n* The [LICENSE](LICENSE)\n* The title and description in [package.json](package.json)\n* Your TypeScript [linting preferences](tslint.json)\n* Your [editor preferences](.editorconfig) (indent size, tabs vs spaces, encoding, etc)\n* Your [package export](forge.config.js) settings\n\n### Things to note\n\nThere are three different TypeScript configurations located in this repository, and all three of them are important:\n* [tsconfig.json](tsconfig.json) contains the configuration used by Visual Studio Code or other editors to configure TypeScript checking. This file pulls in additional type information from the [types](types/) directory, which contains a type definition necessary for proper code completion on imported Vue modules in Visual Studio Code.\n* [_compilerc](_compilerc) contains the two type definitions that are actually used when transpiling for use with Electron, one for development (used when running `npm start`) and one for production (used when running `npm run make`).\n* Due to a [known issue](https://github.com/electron-userland/electron-forge/issues/249) with `npm@4` and `@5`, it's advised to use `npm@3` with Electron Forge: ```npm install -g npm@3```\n\n### Known issues/future work\n\n* SCSS works, but the indented Sass format doesn't build properly.\n* It would be nice if this was a vue-cli, cookecutter, or yeoman scaffold.\n\n### Not what you were looking for?\n\nNot interested in using TypeScript with Vue? Prefer to start with something simpler? I recommend checking out the available starter [templates](https://github.com/electron-userland/electron-forge-templates) that [Electron Forge](https://github.com/electron-userland/electron-forge) offers for initializing projects.\n\nWant something with more stuff/customizability/documentation out of the box? Prefer to use Webpack instead of [Electron Compile](https://github.com/electron/electron-compile)? I recommend taking a look at [electron-vue](https://github.com/SimulatedGREG/electron-vue), which allows for scaffolding projects using vue-cli.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbdero%2Felectron-vue-typescript-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbdero%2Felectron-vue-typescript-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbdero%2Felectron-vue-typescript-starter/lists"}