{"id":13402978,"url":"https://github.com/reZach/secure-electron-template","last_synced_at":"2025-03-14T08:31:20.457Z","repository":{"id":41263793,"uuid":"231309416","full_name":"reZach/secure-electron-template","owner":"reZach","description":"The best way to build Electron apps with security in mind.","archived":false,"fork":false,"pushed_at":"2024-04-14T18:01:33.000Z","size":10388,"stargazers_count":1600,"open_issues_count":21,"forks_count":145,"subscribers_count":17,"default_branch":"master","last_synced_at":"2024-05-02T02:39:29.049Z","etag":null,"topics":["boilerplate","electron","i18next","react","redux","security","template","webpack"],"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/reZach.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"reZach"}},"created_at":"2020-01-02T04:48:11.000Z","updated_at":"2024-07-30T21:39:47.549Z","dependencies_parsed_at":"2023-02-18T03:45:49.654Z","dependency_job_id":"7dfb9a88-2a99-4eb4-ba30-3bc0ca06c26f","html_url":"https://github.com/reZach/secure-electron-template","commit_stats":null,"previous_names":[],"tags_count":86,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reZach%2Fsecure-electron-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reZach%2Fsecure-electron-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reZach%2Fsecure-electron-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reZach%2Fsecure-electron-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reZach","download_url":"https://codeload.github.com/reZach/secure-electron-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221449533,"owners_count":16823609,"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","i18next","react","redux","security","template","webpack"],"created_at":"2024-07-30T19:01:23.691Z","updated_at":"2024-10-25T18:30:57.877Z","avatar_url":"https://github.com/reZach.png","language":"JavaScript","readme":"# secure-electron-template\nA current electron app template with the most popular frameworks, designed and built with security in mind. (If you are curious about what makes an electron app secure, please check out [this page](https://github.com/reZach/secure-electron-template/blob/master/docs/secureapps.md)).\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=reZach_secure-electron-template\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=reZach_secure-electron-template)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=reZach_secure-electron-template\u0026metric=security_rating)](https://sonarcloud.io/dashboard?id=reZach_secure-electron-template)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=reZach_secure-electron-template\u0026metric=sqale_rating)](https://sonarcloud.io/dashboard?id=reZach_secure-electron-template)\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=reZach_secure-electron-template\u0026metric=bugs)](https://sonarcloud.io/dashboard?id=reZach_secure-electron-template)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=reZach_secure-electron-template\u0026metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=reZach_secure-electron-template)\n\n## How to get started\nTo get started, clone the repository by clicking the [![Use this template](https://github.com/reZach/secure-electron-template/blob/master/docs/imgs/usethistemplate.png \"Use this template\")](https://github.com/reZach/secure-electron-template/generate) button, or through the command line (`git clone https://github.com/reZach/secure-electron-template.git`). \n\nOnce cloned, install the dependencies for the repo by running the following commands (you do _not_ have to run the first command if your command line is already inside the newly cloned repository):\n\n```\ncd secure-electron-template\nnpm i\nnpm run dev\n```\n\n\u003e Are you using `yarn`? You'll want to [read this issue](https://github.com/reZach/secure-electron-template/issues/62).\n\nWhen you'd like to test your app in production, or package it for distribution, please navigate to [this page](https://github.com/reZach/secure-electron-template/blob/master/docs/scripts.md) for more details on how to do this.\n\n## Demo\n![Demo](https://github.com/reZach/secure-electron-template/blob/master/docs/imgs/intro.gif \"Demo\")\n\n## Features\nTaken from the [best-practices](https://electronjs.org/docs/tutorial/security) official page, here is what this repository offers!\n\n1. [Only load secure content](https://electronjs.org/docs/tutorial/security#1-only-load-secure-content) - ✅ (But the developer is responsible for loading secure assets only 🙂)\n2. [Do not enable node.js integration for remote content](https://electronjs.org/docs/tutorial/security#2-do-not-enable-nodejs-integration-for-remote-content) - ✅\n3. [Enable context isolation for remote content](https://electronjs.org/docs/tutorial/security#3-enable-context-isolation-for-remote-content) - ✅\n4. [Handle session permission requests from remote content](https://electronjs.org/docs/tutorial/security#4-handle-session-permission-requests-from-remote-content) - ✅\n5. [Do not disable websecurity](https://electronjs.org/docs/tutorial/security#5-do-not-disable-websecurity) - ✅\n6. [Define a content security policy](https://electronjs.org/docs/tutorial/security#6-define-a-content-security-policy) - ✅\n7. [Do not set allowRunningInsecureContent to true](https://electronjs.org/docs/tutorial/security#7-do-not-set-allowrunninginsecurecontent-to-true) - ✅\n8. [Do not enable experimental features](https://electronjs.org/docs/tutorial/security#8-do-not-enable-experimental-features) - ✅\n9. [Do not use enableBlinkFeatures](https://electronjs.org/docs/tutorial/security#9-do-not-use-enableblinkfeatures) - ✅\n10. [Do not use allowpopups](https://electronjs.org/docs/tutorial/security#10-do-not-use-allowpopups) - ✅\n11. [\u0026lt;webview\u0026gt; verify options and params](https://electronjs.org/docs/tutorial/security#11-verify-webview-options-before-creation) - ✅\n12. [Disable or limit navigation](https://electronjs.org/docs/tutorial/security#12-disable-or-limit-navigation) - ✅\n13. [Disable or limit creation of new windows](https://electronjs.org/docs/tutorial/security#13-disable-or-limit-creation-of-new-windows) - ✅\n14. [Do not use openExternal with untrusted content](https://electronjs.org/docs/tutorial/security#14-do-not-use-openexternal-with-untrusted-content) - ✅\n15. [Disable remote module](https://electronjs.org/docs/tutorial/security#15-disable-the-remote-module) - ✅\n16. [Filter the remote module](https://electronjs.org/docs/tutorial/security#16-filter-the-remote-module) - ✅\n17. [Use a current version of electron](https://electronjs.org/docs/tutorial/security#17-use-a-current-version-of-electron) - ✅\n\n## Included frameworks\nBuilt-in to this template are a number of popular frameworks already wired up to get you on the road running.\n\n- [Electron](https://electronjs.org/)\n- [React](https://reactjs.org/)\n- [Typescript](https://www.typescriptlang.org)\n- [Redux](https://redux.js.org/) (with [Redux toolkit](https://redux-toolkit.js.org/))\n- [Babel](https://babeljs.io/)\n- [Webpack](https://webpack.js.org/) (with [webpack-dev-server](https://github.com/webpack/webpack-dev-server))\n- [Electron builder](https://www.electron.build/) (for packaging up your app)\n- [Mocha](https://mochajs.org/)\n\n## Bonus modules\nWhat would a template be without some helpful additions?\n\n- [i18next](https://www.i18next.com/) (with [this plugin](https://github.com/reZach/i18next-electron-fs-backend) for localization).\n- [Store](https://github.com/reZach/secure-electron-store) (for saving config/data)\n- [Context menu](https://github.com/reZach/secure-electron-context-menu) (supports custom context menus)\n- [Easy redux undo](https://github.com/reZach/easy-redux-undo) (for undo/redoing your redux actions)\n- [License key validation](https://github.com/reZach/secure-electron-license-keys) (for validating a user has the proper license to use your app) **new!**\n\n## Architecture\nFor a more detailed view of the architecture of the template, please check out [here](https://github.com/reZach/secure-electron-template/blob/master/docs/architecture.md). I would _highly_ recommend reading this document to get yourself familiarized with this template.\n\n## FAQ\nPlease see [our faq](https://github.com/reZach/secure-electron-template/blob/master/docs/faq.md) for any common questions you might have.\n**NEW TO ELECTRON?** Please visit [this page](https://github.com/reZach/secure-electron-template/blob/master/docs/newtoelectron.md).\n\n## Show us your apps!\nIf you've built any applications with our template, we'd [love to see them!](https://github.com/reZach/secure-electron-template/blob/master/docs/yourapps.md).\n","funding_links":["https://github.com/sponsors/reZach"],"categories":["JavaScript","Boilerplates","Javascript"],"sub_categories":["Tools","Samples"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FreZach%2Fsecure-electron-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FreZach%2Fsecure-electron-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FreZach%2Fsecure-electron-template/lists"}