{"id":13406342,"url":"https://github.com/daltonmenezes/electron-app","last_synced_at":"2025-04-09T05:01:30.916Z","repository":{"id":40254429,"uuid":"460429656","full_name":"daltonmenezes/electron-app","owner":"daltonmenezes","description":"💅 An Electron app boilerplate with React 19, TypeScript 5, Tailwind 4, shadcn/ui, Electron Vite, Biome, GitHub Action releases and more.","archived":false,"fork":false,"pushed_at":"2025-03-04T01:21:06.000Z","size":2658,"stargazers_count":567,"open_issues_count":0,"forks_count":41,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-02T04:01:36.256Z","etag":null,"topics":["boilerplate","css","electron","electron-builder","esbuild","eslint","github-actions","hacktoberfest","nodejs","prettier","react","reactjs","sass","template","typescript","vite"],"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/daltonmenezes.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},"funding":{"github":"daltonmenezes","patreon":"daltonmenezes"}},"created_at":"2022-02-17T12:38:52.000Z","updated_at":"2025-04-01T09:53:33.000Z","dependencies_parsed_at":"2024-01-18T23:05:15.928Z","dependency_job_id":"87b69886-2724-4ccc-80d6-5a8660014a16","html_url":"https://github.com/daltonmenezes/electron-app","commit_stats":null,"previous_names":[],"tags_count":12,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daltonmenezes%2Felectron-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daltonmenezes%2Felectron-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daltonmenezes%2Felectron-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daltonmenezes%2Felectron-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/daltonmenezes","download_url":"https://codeload.github.com/daltonmenezes/electron-app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980815,"owners_count":21027804,"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","css","electron","electron-builder","esbuild","eslint","github-actions","hacktoberfest","nodejs","prettier","react","reactjs","sass","template","typescript","vite"],"created_at":"2024-07-30T19:02:27.712Z","updated_at":"2025-04-09T05:01:30.882Z","avatar_url":"https://github.com/daltonmenezes.png","language":"TypeScript","funding_links":["https://github.com/sponsors/daltonmenezes","https://patreon.com/daltonmenezes","https://www.patreon.com/daltonmenezes"],"categories":["TypeScript","boilerplate"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\u003cimg src=\"./docs/images/bullet.svg\" width=\"19\" /\u003e Electron App\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e💅 An Electron app boilerplate with React v19, TypeScript v5, Tailwind v4, shadcn/ui, Electron Vite, Biome, \u003cstrong\u003eGitHub Action releases\u003c/strong\u003e and more.\n  \u003cbr/\u003e\u003cbr/\u003e\n   \u003c!-- GitHub --\u003e\n  \u003ca href=\"https://github.com/sponsors/daltonmenezes\"\u003e\n    \u003cimg alt=\"github url\" src=\"https://img.shields.io/badge/support%20on-github-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=F28BA9\"/\u003e\n  \u003c/a\u003e\n  \u003c!-- Patreon --\u003e\n  \u003ca href=\"https://www.patreon.com/daltonmenezes\"\u003e\n    \u003cimg alt=\"patreon url\" src=\"https://img.shields.io/badge/support%20on-patreon-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=B181F1\"/\u003e\n  \u003c/a\u003e\n  \u003c!-- Version --\u003e\n  \u003ca href=\"https://github.com/daltonmenezes/electron-app/releases\"\u003e\n     \u003cimg alt=\"releases url\" src=\"https://img.shields.io/github/v/release/daltonmenezes/electron-app?style=for-the-badge\u0026labelColor=1C1E26\u0026color=61ffca\"/\u003e\n  \u003c/a\u003e  \n  \u003c!-- License --\u003e\n  \u003ca href=\"https://github.com/daltonmenezes/electron-app/blob/main/LICENSE\"\u003e\n    \u003cimg alt=\"license url\" src=\"https://img.shields.io/badge/license%20-MIT-1C1E26?style=for-the-badge\u0026labelColor=1C1E26\u0026color=F28BA9\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#electron-app\"\u003e\n    \u003cimg alt=\"preview\" src=\"./docs/images/preview.png\" \u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n# \u003cimg src=\"./docs/images/bullet.svg\" width=\"19\" /\u003e 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/Screen routing included\n  - 😎 Preload (context bridge) already configured\n  - 🔮 GitHub Action releases with `Windows`, `Mac` and `Linux` binaries\n  - 🔒 Source Code Protection support\n  - 🍪 Absolute paths support\n- **Technologies**:\n  - 🔋 Electron\n  - 🔥 ReactJS v19\n  - 🌎 React Router DOM v7 and Electron Router DOM v2\n  - 🧐 React Developer Tools\n  - 🔍 Code inspector (holding \u003ckbd title=\"Alt\"\u003e`Alt`\u003c/kbd\u003e or \u003ckbd title=\"Alt\"\u003e`Option`\u003c/kbd\u003e key on DOM element and clicking on it)\n  - 💙 TypeScript v5\n  - 📦 Electron Vite\n  - ✨ TailwindCSS v4\n  - 🎨 shadcn/ui\n  - 🍦 lucide-icons\n  - 💫 Biome / EditorConfig\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 22x version if it's important for you!\n\n# \u003cimg src=\"./docs/images/bullet.svg\" width=\"19\" /\u003e Requirements\n- [Node.js 20](https://nodejs.org/en/download/)\n- [pnpm 10](https://pnpm.io/installation)\n\n# \u003cimg src=\"./docs/images/bullet.svg\" width=\"19\" /\u003e Installation\n```bash\nnpx degit daltonmenezes/electron-app/template project_name\n```\n```bash\ncd project_name\npnpm install\npnpm dev\n```\n\nNow, look at the **package.json** file in the root directory, you should update some of that settings with your project branding.\n\n# \u003cimg src=\"./docs/images/bullet.svg\" width=\"14\" /\u003e Adding new dependencies\nFor security reasons, **pnpm** has the [onlyBuiltDependenciesFile](https://pnpm.io/package_json#pnpmonlybuiltdependenciesfile) property where only \ndependencies listed in the [trusted-dependencies-scripts.json](./template/trusted-dependencies-scripts.json) file can perform the postscripts execution. So, if you want to add a new dependency that needs to run a postscript, you should add it to the [trusted-dependencies-scripts.json](./template/trusted-dependencies-scripts.json) file list.\n\n# \u003cimg src=\"./docs/images/bullet.svg\" width=\"14\" /\u003e Distribution\n\n### For all platforms\n\n\u003e **Note**: Check [Electron Builder docs](https://www.electron.build/cli) for more knowledge\n\n```\npnpm build\n```\n\n### For a specific one\n\n```bash\npnpm build --mac\n# OR\npnpm build --win\n# OR\npnpm build --linux\n```\n\nThe builded apps will be available in the `dist` folder.\n\n# \u003cimg src=\"./docs/images/bullet.svg\" width=\"19\" /\u003e Documents\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd valign=\"center\"\u003e\n      \u003cp align=\"center\"\u003e\n        \u003ca href=\"https://electron-router-dom.daltonmenezes.com/docs\"\u003eRouting\u003c/a\u003e\n      \u003c/p\u003e\n    \u003c/td\u003e\n    \u003ctd valign=\"center\"\u003e\n      \u003cp align=\"center\"\u003e\n        \u003ca href=\"./docs/STRUCTURE.md\"\u003eStructure Overview\u003c/a\u003e\n      \u003c/p\u003e\n    \u003c/td\u003e\n    \u003ctd valign=\"center\"\u003e\n      \u003cp align=\"center\"\u003e\n        \u003ca href=\"./docs/SOURCE_CODE_PROTECTION.md\"\u003eSource Code Protection\u003c/a\u003e\n      \u003c/p\u003e\n    \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n    \u003ctd valign=\"center\"\u003e\n      \u003cp align=\"center\"\u003e\n        \u003ca href=\"./docs/RELEASING.md\"\u003eReleasing\u003c/a\u003e\n      \u003c/p\u003e\n    \u003c/td\u003e\n    \u003ctd valign=\"center\"\u003e\n      \u003cp align=\"center\"\u003e\n        \u003ca href=\"./docs/UNSIGNED_APPS.md\"\u003eRunning released unsigend apps\u003c/a\u003e\n      \u003c/p\u003e\n    \u003c/td\u003e\n    \u003ctd valign=\"center\"\u003e\n      \u003cp align=\"center\"\u003e\n        \u003ca href=\"./docs/FAQ.md\"\u003eFAQ - Frequently Asked Questions\u003c/a\u003e\n      \u003c/p\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n# Contributing\n\u003e **Note**: contributions are always welcome, but always **ask first**, — please — before work on a PR.\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 Patreon\n- :star2: Giving a star on this repository\n\n# License\n\n[MIT © Dalton Menezes](https://github.com/daltonmenezes/electron-app/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaltonmenezes%2Felectron-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaltonmenezes%2Felectron-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaltonmenezes%2Felectron-app/lists"}