{"id":13816548,"url":"https://github.com/electron/electron-quick-start-typescript","last_synced_at":"2025-10-02T13:31:27.037Z","repository":{"id":38357584,"uuid":"104968909","full_name":"electron/electron-quick-start-typescript","owner":"electron","description":"Clone to try a simple Electron app (in TypeScript)","archived":true,"fork":false,"pushed_at":"2024-01-03T19:55:07.000Z","size":388,"stargazers_count":1177,"open_issues_count":1,"forks_count":320,"subscribers_count":18,"default_branch":"main","last_synced_at":"2024-04-14T03:56:18.730Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/electron.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-09-27T03:43:27.000Z","updated_at":"2024-04-12T10:01:54.000Z","dependencies_parsed_at":"2023-02-11T00:20:17.660Z","dependency_job_id":"807dcf33-72be-43d9-a8a0-c1542b9b5c67","html_url":"https://github.com/electron/electron-quick-start-typescript","commit_stats":{"total_commits":99,"total_committers":15,"mean_commits":6.6,"dds":"0.24242424242424243","last_synced_commit":"eb58abdbd1dd8cb0d2df9608fccf12ad989a189b"},"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Felectron-quick-start-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Felectron-quick-start-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Felectron-quick-start-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Felectron-quick-start-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electron","download_url":"https://codeload.github.com/electron/electron-quick-start-typescript/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219866464,"owners_count":16554232,"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":[],"created_at":"2024-08-04T05:00:45.444Z","updated_at":"2025-10-02T13:31:26.698Z","avatar_url":"https://github.com/electron.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003e [!CAUTION]\n\u003e This template is **deprecated**. To get started with an Electron + TypeScript project, we highly recommend starting with [Electron Forge](https://www.electronforge.io/)'s official TypeScript templates.\n\n# electron-quick-start-typescript\n\n**Clone and run for a quick way to see Electron in action.**\n\nThis is a [TypeScript](https://www.typescriptlang.org) port of the [Electron Quick Start repo](https://github.com/electron/electron-quick-start) -- a minimal Electron application based on the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start) within the Electron documentation.\n\n**Use this app along with the [Electron API Demos](http://electron.atom.io/#get-started) app for API code examples to help you get started.**\n\nA basic Electron application needs just these files:\n\n- `package.json` - Points to the app's main file and lists its details and dependencies.\n- `main.ts` - Starts the app and creates a browser window to render HTML. This is the app's **main process**.\n- `index.html` - A web page to render. This is the app's **renderer process**.\n\nYou can learn more about each of these components within the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start).\n\n## To Use\n\nTo clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:\n\n```bash\n# Clone this repository\ngit clone https://github.com/electron/electron-quick-start-typescript\n# Go into the repository\ncd electron-quick-start-typescript\n# Install dependencies\nnpm install\n# Run the app\nnpm start\n```\n\nNote: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt.\n\n## Re-compile automatically\n\nTo recompile automatically and to allow using [electron-reload](https://github.com/yan-foto/electron-reload), run this in a separate terminal:\n\n```bash\nnpm run watch\n```\n\n## Resources for Learning Electron\n\n- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation\n- [Electron Fiddle](https://electronjs.org/fiddle) - create, play, and share small Electron experiments\n- [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - sample starter apps created by the community\n- [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app\n- [electron/simple-samples](https://github.com/electron/simple-samples) - small applications with ideas for taking them further\n- [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs\n\n## License\n\n[CC0 1.0 (Public Domain)](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron%2Felectron-quick-start-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectron%2Felectron-quick-start-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron%2Felectron-quick-start-typescript/lists"}