{"id":22645384,"url":"https://github.com/heliomarpm/electron-quick-start","last_synced_at":"2025-04-12T00:33:43.095Z","repository":{"id":105892427,"uuid":"608942861","full_name":"heliomarpm/electron-quick-start","owner":"heliomarpm","description":"Electron Quick Start","archived":false,"fork":false,"pushed_at":"2024-09-30T00:40:08.000Z","size":276,"stargazers_count":9,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T20:15:39.687Z","etag":null,"topics":["cross-platform","desktop","desktop-app","desktop-webapp","electron","electron-app","electron-builder","electron-quick-start","electron-vanilla-js","electron-vanillajs","vanilla-js"],"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/heliomarpm.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","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":"heliomarpm","ko_fi":"heliomarpm","liberapay":"heliomarpm","custom":["https://bit.ly/paypal-udeler","https://bit.ly/paypalbr-udeler"]}},"created_at":"2023-03-03T03:17:18.000Z","updated_at":"2024-09-30T00:40:11.000Z","dependencies_parsed_at":"2024-06-01T01:55:16.493Z","dependency_job_id":"3acc9752-64e0-42b4-866a-0f5045d90e71","html_url":"https://github.com/heliomarpm/electron-quick-start","commit_stats":null,"previous_names":[],"tags_count":37,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heliomarpm%2Felectron-quick-start","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heliomarpm%2Felectron-quick-start/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heliomarpm%2Felectron-quick-start/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heliomarpm%2Felectron-quick-start/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/heliomarpm","download_url":"https://codeload.github.com/heliomarpm/electron-quick-start/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248501674,"owners_count":21114676,"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":["cross-platform","desktop","desktop-app","desktop-webapp","electron","electron-app","electron-builder","electron-quick-start","electron-vanilla-js","electron-vanillajs","vanilla-js"],"created_at":"2024-12-09T06:05:22.180Z","updated_at":"2025-04-12T00:33:43.072Z","avatar_url":"https://github.com/heliomarpm.png","language":"JavaScript","funding_links":["https://github.com/sponsors/heliomarpm","https://ko-fi.com/heliomarpm","https://liberapay.com/heliomarpm","https://bit.ly/paypal-udeler","https://bit.ly/paypalbr-udeler"],"categories":[],"sub_categories":[],"readme":"\u003cdiv id=\"top\" align=\"center\" style=\"text-align:center;\"\u003e\n\u003ch1\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/heliomarpm/design_templates/main/Logo_QuickElectronJS.png?token=GHSAT0AAAAAAB3AKRA5UDCVHAACJC5WHYGKZS2QIBA\" width=\"120\"/\u003e\n  \u003cbr\u003e Electron Quick Start - vanillaJS\n\n  ![CodeQL](https://github.com/heliomarpm/electron-quick-start/actions/workflows/codeql-analysis.yml/badge.svg) ![Publish](https://github.com/heliomarpm/electron-quick-start/actions/workflows/publish.yml/badge.svg) \u003ca href=\"https://navto.me/heliomarpm\" target=\"_blank\"\u003e\u003cimg src=\"https://navto.me/assets/navigatetome-brand.png\" width=\"32\"/\u003e\u003c/a\u003e\n\u003c/h1\u003e\n\n\u003cp\u003e\n  \u003c!-- PixMe --\u003e\n  \u003ca href=\"https://www.pixme.bio/heliomarpm\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg alt=\"pixme url\" src=\"https://img.shields.io/badge/donate%20on-pixme-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=28f4f4\"/\u003e\n  \u003c/a\u003e\n  \u003c!-- PayPal --\u003e\n  \u003ca href=\"https://bit.ly/paypal-sponsor-heliomarpm\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg alt=\"paypal url\" src=\"https://img.shields.io/badge/paypal-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=0475fe\"/\u003e\n  \u003c/a\u003e\n  \u003c!-- Ko-fi --\u003e\n  \u003ca href=\"https://ko-fi.com/heliomarpm\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg alt=\"kofi url\" src=\"https://img.shields.io/badge/kofi-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=ff5f5f\"/\u003e\n  \u003c/a\u003e\n  \u003c!-- LiberaPay --\u003e  \n  \u003ca href=\"https://liberapay.com/heliomarpm\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n     \u003cimg alt=\"liberapay url\" src=\"https://img.shields.io/badge/liberapay-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=f6c915\"/\u003e\n  \u003c/a\u003e\n  \u003c!-- Version --\u003e\n  \u003ca href=\"https://github.com/heliomarpm/electron-quick-start/releases\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n     \u003cimg alt=\"releases url\" src=\"https://img.shields.io/github/v/release/heliomarpm/electron-quick-start?style=for-the-badge\u0026labelColor=1C1E26\u0026color=2ea043\"/\u003e\n  \u003c/a\u003e  \n  \u003c!-- License --\u003e\n  \u003ca href=\"https://github.com/heliomarpm/electron-quick-start/blob/main/LICENSE\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg alt=\"license url\" src=\"https://img.shields.io/badge/license%20-MIT-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=61ffca\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003c/div\u003e\n\n\nClone and run for a quick way to see Electron in action.\n\nThis is a minimal Electron application based on the [Quick Start Guide](https://electronjs.org/docs/latest/tutorial/quick-start) within the Electron documentation.\n\nA basic Electron application needs just these files:\n\npackage.json - Points to the app's main file and lists its details and dependencies.\nmain.js - Starts the app and creates a browser window to render HTML. This is the app's main process.\nindex.html - A web page to render. This is the app's renderer process.\npreload.js - A content script that runs before the renderer process loads.\nYou can learn more about each of these components in depth within the [Tutorial](https://electronjs.org/docs/latest/tutorial/tutorial-prerequisites).\n\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#electron-app\"\u003e\n    \u003cimg alt=\"preview\" src=\"https://raw.githubusercontent.com/heliomarpm/screenshots/main/electron-quick-start.png\" \u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n# Features\n- **Stands out**\n  - 🔥 Fast and Ready-to-go with a well-thought-out structure\n  - 🚀 Auto reload for main and **Fast Refresh** for renderer process\n  - 🎉 Window and Screen routing included\n  - 😎 Preload (context bridge) already configured\n  - 🙀 IPC communication example included\n  - 🔮 GitHub Action releases with `Windows`, `Mac` and `Linux` binaries\n\n- **Technologies**:\n  - 🔋 Electron\n  - 🔥 Javascript\n  \u003c!-- - 💫 Eslint / Prettier / EditorConfig  --\u003e\n  - 📦 Electron Builder\n  - 🔮 action-electron-builder\n\n\u003cbr/\u003e\n\n\u003e :warning: If **Windows 7** and **8** support is important for your project, you should know that Electron in a version greater than 22x no longer supports it. You can read more about it [here](https://www.electronjs.org/docs/latest/breaking-changes#removed-windows-7--8--81-support). Therefore, you must downgrade Electron to the version cited in this context!\n\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/heliomarpm/electron-quick-start\n# Go into the repository\ncd electron-quick-start\n# Install dependencies\nnpm install\n# Run the app\nnpm start\n-- or --\n# Run the app mode develop\nnpm run dev\n```\n\n\u003e **Note**: 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\n# Releasing\n\u003e **Note**: to be able to perform `auto-updates` you will need a `code signed app`, for this purpose you will need to configure it by yourself, so check the [electron-builder](https://www.electron.build/code-signing) and [action-electron-builder](https://github.com/samuelmeuli/action-electron-builder#code-signing) docs please to get know how to do this.\n\nTo release your app on a GitHub release with `Windows`, `Mac` and `Linux` binaries, you can perform the following commands:\n\n```bash\ngit pull\nnpm run deploy\n```\n\n\u003e **Note**: Script for make release is contribution by @daltonmenezes\n\n\n## Dev Dependencies\n\n- [electron](https://ghub.io/electron): Build cross platform desktop apps with JavaScript, HTML, and CSS\n- [electron-builder](https://ghub.io/electron-builder): A complete solution to package and build a ready for distribution Electron app for MacOS, Windows and Linux with “auto update” support out of the box\n- [open](https://ghub.io/open): Open stuff like URLs, files, executables. Cross-platform.\n- [semver](https://ghub.io/semver): The semantic version parser used by npm.\n\n## Resources for Learning Electron\n\n- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation\n\n# Contributing\n\nPlease make sure to read the [Contributing Guide](https://github.com/heliomarpm/electron-quick-start/blob/master/docs/CONTRIBUTING.md) before making a pull request.\n\n\nThank you to all the people who already contributed to project!\n\n\u003ca href=\"https://github.com/heliomarpm/electron-quick-start/graphs/contributors\" target=\"_blank\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=heliomarpm/electron-quick-start\" /\u003e\n\u003c/a\u003e\n\n###### Made with [contrib.rocks](https://contrib.rocks).\n\nThat said, there's a bunch of ways you can contribute to this project, like by:\n\n- :beetle: Reporting a bug\n- :page_facing_up: Improving this documentation\n- :rotating_light: Sharing this project and recommending it to your friends\n- :dollar: Supporting this project on GitHub Sponsors or Ko-fi\n- :star2: Giving a star on this repository\n\n\n## Donate\n\nIf you appreciate that, please consider donating to the Developer.\n\n\u003cp\u003e\n  \u003c!-- PixMe --\u003e\n  \u003ca href=\"https://www.pixme.bio/heliomarpm\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg alt=\"pixme url\" src=\"https://img.shields.io/badge/donate%20on-pixme-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=28f4f4\"/\u003e\n  \u003c/a\u003e\n  \u003c!-- PayPal --\u003e\n  \u003ca href=\"https://bit.ly/paypal-sponsor-heliomarpm\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg alt=\"paypal url\" src=\"https://img.shields.io/badge/paypal-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=0475fe\"/\u003e\n  \u003c/a\u003e\n  \u003c!-- Ko-fi --\u003e\n  \u003ca href=\"https://ko-fi.com/heliomarpm\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg alt=\"kofi url\" src=\"https://img.shields.io/badge/kofi-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=ff5f5f\"/\u003e\n  \u003c/a\u003e\n  \u003c!-- LiberaPay --\u003e  \n  \u003ca href=\"https://liberapay.com/heliomarpm\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n     \u003cimg alt=\"liberapay url\" src=\"https://img.shields.io/badge/liberapay-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=f6c915\"/\u003e\n  \u003c/a\u003e  \n  \u003c!-- GitHub Sponsors --\u003e\n  \u003ca href=\"https://github.com/sponsors/heliomarpm\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg alt=\"github sponsors url\" src=\"https://img.shields.io/badge/GitHub%20-Sponsor-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=db61a2\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## License\n\n[MIT © Heliomar P. Marques](https://github.com/heliomarpm/electron-quick-start/blob/main/LICENSE) \u003ca href=\"#top\"\u003e🔝\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheliomarpm%2Felectron-quick-start","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheliomarpm%2Felectron-quick-start","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheliomarpm%2Felectron-quick-start/lists"}