{"id":15118756,"url":"https://github.com/DarkGuy10/NextJS-Electron-Boilerplate","last_synced_at":"2025-09-28T01:30:38.977Z","repository":{"id":172929317,"uuid":"649616290","full_name":"DarkGuy10/NextJS-Electron-Boilerplate","owner":"DarkGuy10","description":"A boilerplate for building desktop apps with Electron and NextJS.","archived":false,"fork":false,"pushed_at":"2024-08-12T16:44:49.000Z","size":4521,"stargazers_count":68,"open_issues_count":15,"forks_count":15,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-15T18:01:22.316Z","etag":null,"topics":["boilerplate","electron","electron-app","electron-boilerplate","electron-builder","electron-next","electron-next-boilerplate","electronjs","nextjs","nextjs14","template","typescript"],"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/DarkGuy10.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/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":null,"patreon":null,"open_collective":null,"ko_fi":"darkguy10","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":["https://www.buymeacoffee.com/darkguy10"]}},"created_at":"2023-06-05T09:10:27.000Z","updated_at":"2025-01-13T12:01:41.000Z","dependencies_parsed_at":"2023-12-03T15:22:52.490Z","dependency_job_id":"baddcc3d-1c1f-4f40-9cd4-ef5a71792bc1","html_url":"https://github.com/DarkGuy10/NextJS-Electron-Boilerplate","commit_stats":{"total_commits":90,"total_committers":3,"mean_commits":30.0,"dds":"0.28888888888888886","last_synced_commit":"0dd19959ddd91bc61787bdd95d2cf5ac92cf6cce"},"previous_names":["darkguy10/prepsilon","darkguy10/nextjs-electron-boilerplate"],"tags_count":10,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkGuy10%2FNextJS-Electron-Boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkGuy10%2FNextJS-Electron-Boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkGuy10%2FNextJS-Electron-Boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkGuy10%2FNextJS-Electron-Boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DarkGuy10","download_url":"https://codeload.github.com/DarkGuy10/NextJS-Electron-Boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234475315,"owners_count":18839358,"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","electron-app","electron-boilerplate","electron-builder","electron-next","electron-next-boilerplate","electronjs","nextjs","nextjs14","template","typescript"],"created_at":"2024-09-26T01:53:37.617Z","updated_at":"2025-09-28T01:30:38.407Z","avatar_url":"https://github.com/DarkGuy10.png","language":"TypeScript","funding_links":["https://ko-fi.com/darkguy10","https://www.buymeacoffee.com/darkguy10"],"categories":["Free Boilerplates"],"sub_categories":[],"readme":"\u003ch3 align=\"center\"\u003e\n\t\u003cimg src=\"https://github.com/DarkGuy10/NextJS-Electron-Boilerplate/assets/62807269/1f7a5a9a-a8c7-4ec7-b5f5-6a4fbfe0f1b2\" alt=\"capybara\" height=\"300px\" /\u003e\u003cbr/\u003e\n\t「NextJS + Electron Boilerplate」\n\u003c/h3\u003e\n\n\u003ch6 align=\"center\"\u003e\n  \u003ca href=\"#-features\"\u003eFeatures\u003c/a\u003e\n  ·\n  \u003ca href=\"#-setting-up\"\u003eSetting Up\u003c/a\u003e\n  ·\n  \u003ca href=\"#-documentation\"\u003eDocumentation\u003c/a\u003e\n  ·\n  \u003ca href=\"#-license\"\u003eLicense\u003c/a\u003e\n\u003c/h6\u003e\n\n\u003cp align=\"center\"\u003e\n\t\u003ca href=\"https://github.com/darkguy10/NextJS-Electron-Boilerplate/stargazers\"\u003e\n\t\t\u003cimg alt=\"Stargazers\" src=\"https://img.shields.io/github/stars/darkguy10/NextJS-Electron-Boilerplate?style=for-the-badge\u0026logo=starship\u0026color=C9CBFF\u0026logoColor=D9E0EE\u0026labelColor=302D41\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://github.com/DarkGuy10/NextJS-Electron-Boilerplate/issues\"\u003e\n\t\t\u003cimg src=\"https://img.shields.io/github/issues/DarkGuy10/NextJS-Electron-Boilerplate?colorA=1e1e28\u0026colorB=bee4ed\u0026logoColor=D9E0EE\u0026logo=gitbook\u0026style=for-the-badge\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/darkguy10/NextJS-Electron-Boilerplate/releases/latest\"\u003e\n  \t\u003cimg alt=\"Releases\" src=\"https://img.shields.io/github/release/darkguy10/NextJS-Electron-Boilerplate?style=for-the-badge\u0026logo=github\u0026color=F2CDCD\u0026logoColor=D9E0EE\u0026labelColor=302D41\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u0026nbsp;\n\n\u003cp align=\"center\"\u003e\n  A neat and highly flexible boilerplate for building cross-platform apps with Electron at the core and NextJS serving as the frontend. The template is pre-configured with a bunch of handy tools to ease out development process. Plus, Typescript is supported from the get-go!\n\u003c/p\u003e\n\n\u0026nbsp;\n\n### ✨ Features\n\n- Pre-configured with [Storybook](https://storybook.js.org/), Eslint, [Prettier](https://prettier.io/) and [Electron Builder](https://www.electron.build)\n- [SVGR](https://react-svgr.com/) pre-installed and configred for easily using SVGs as React components\n- Pre-configured CI/CD workflows through github actions\n- Binaries support auto-updates by default\n- Typescript and ESModules supported by default\n- Import aliases supported for both main and renderer processes\n- Completely flexible, transparent and customizable structure\n- Intuitive structure to avoid messy codebase\n- Documented \u003ca href=\"#-scripts\"\u003enpm scripts\u003c/a\u003e\n\n\u0026nbsp;\n\n\u003e [!TIP]\n\u003e ​[Nextron](https://github.com/saltyshiomix/nextron) has been around for long, and has developed quite the userbase (2.8k stars as of writing). Therefore, its a very valid question: why not just use Nextron?\n\u003e And the only valid answer is: _flexibiliy_.\u003cbr/\u003e\n\u003e With Nextron, there's a limit to how much you can tweak your code, and it might actually be a plus point if you want to focus on getting a basic app done.\u003cbr /\u003e\n\u003e However, if you're like me, and you like having full control of your project, and not being at the mercy of a third-party project mantainer, then welcome aboard mate—this is just the thing you were searching for!\n\n\u0026nbsp;\n\n### 🚀 Setting Up\n\nThis repo is a public template and you can easily use it create a new repo. A bit about that in [this article](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).\n\nOnce you're done, just clone _your_ repo (not this template) and install the dependencies (with `yarn install`) to get started\n\n\u0026nbsp;\n\n### 📚 Documentation\n\n#### 📂 Structure\n\n```\n.\n├── assets\n│   ├── icon.icns\n│   ├── icon.ico\n│   └── icon.png\n├── backend\n│   ├── main.ts\n│   ├── preload.ts\n│   ├── README.md\n│   ├── tsconfig.json\n│   └── .eslintrc.json\n├── frontend\n│   ├── app\n│   │   ├── assets\n│   |   │   ├── edit.svg\n│   |   │   └── menhera.png\n│   │   ├── favicon.ico\n│   │   ├── globals.css\n│   │   ├── layout.tsx\n│   │   ├── page.module.css\n│   │   └── page.tsx\n│   ├── context.d.ts\n│   ├── .eslintrc.json\n│   └── tsconfig.json\n├── next.config.js\n├── electron-builder.yml\n├── package.json\n├── README.md\n└── yarn.lock\n\n```\n\n- `assets/`: Contains app icons used during run and build times.\n- `backend/`: This is where your electron main processes reside.\n- `frontend/`: This is where your NextJS app lives.\n- `next.config.js`: NextJS config file.\n- `electron-builder.yml`: Electron builder config file.\n\nThere's more information about `frontend` and `backend` parts in the README files in their respective directories.\n\n\u0026nbsp;\n\n#### 💻 Scripts\n\nYou can run these scripts from your terminal using\n\n```\nyarn \u003cSCRIPT_NAME\u003e\n```\n\n\u003ctable\u003e \n\t\u003ctr\u003e\n\t\t\u003ctd\u003e \u003cpre\u003estart\u003c/pre\u003e \u003c/td\u003e\n\t\t\u003ctd\u003eStarts the app in development mode\u003c/td\u003e\n\t\u003c/tr\u003e\n\t\u003ctr\u003e\n\t\t\u003ctd\u003e \u003cpre\u003elint\u003c/pre\u003e \u003c/td\u003e\n\t\t\u003ctd\u003eChecks for code styling issues with prettier, also runs eslint on backend and frontend\u003c/td\u003e\n\t\u003c/tr\u003e\n\t\u003ctr\u003e\n\t\t\u003ctd\u003e \u003cpre\u003elint:fix\u003c/pre\u003e \u003c/td\u003e\n\t\t\u003ctd\u003eFormats code with prettier (write mode)\u003c/td\u003e\n\t\u003c/tr\u003e\n\t\u003ctr\u003e\n\t\t\u003ctd\u003e \u003cpre\u003estorybook\u003c/pre\u003e \u003c/td\u003e\n\t\t\u003ctd\u003eStarts the Storybook dev server\u003c/td\u003e\n\t\u003c/tr\u003e\n\t\u003ctr\u003e\n\t\t\u003ctd\u003e \u003cpre\u003ebuild\u003c/pre\u003e \u003c/td\u003e\n\t\t\u003ctd\u003eBuilds the electron app (the `lint` script is auto-executed before building)\u003c/td\u003e\n\t\u003c/tr\u003e\n\t\u003ctr\u003e\n\t\t\u003ctd\u003e\u003cpre\u003efrontend:dev\u003c/pre\u003e\u003c/td\u003e\n\t\t\u003ctd\u003eStarts the NextJS development server\u003c/td\u003e\n\t\u003c/tr\u003e\n\t\u003ctr\u003e\n\t\t\u003ctd\u003e \u003cpre\u003efrontend:lint\u003c/pre\u003e \u003c/td\u003e\n\t\t\u003ctd\u003eRuns eslint only on the `frontend/` directory\u003c/td\u003e\n\t\u003c/tr\u003e\n\t\u003ctr\u003e\n\t\t\u003ctd\u003e \u003cpre\u003efrontend:build\u003c/pre\u003e \u003c/td\u003e\n\t\t\u003ctd\u003eBuilds only the frontend NextJS app to `frontend/build/` directory\u003c/td\u003e\n\t\u003c/tr\u003e\n\t\u003ctr\u003e\n\t\t\u003ctd\u003e \u003cpre\u003ebackend:lint\u003c/pre\u003e \u003c/td\u003e\n\t\t\u003ctd\u003eRuns eslint only on the `backend/` directory\u003c/td\u003e\n\t\u003c/tr\u003e\n\t\u003ctr\u003e\n\t\t\u003ctd\u003e \u003cpre\u003ebackend:build\u003c/pre\u003e \u003c/td\u003e\n\t\t\u003ctd\u003eTranspiles the backend code to `backend/build/` directory\u003c/td\u003e\n\t\u003c/tr\u003e\n\u003c/table\u003e\n\n\u0026nbsp;\n\n### 📜 License\n\n\u003ca href=\"https://github.com/darkguy10/NextJS-Electron-Boilerplate/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/darkguy10/NextJS-Electron-Boilerplate?style=for-the-badge\u0026labelColor=302D41\u0026color=C9CBFF\"/\u003e\u003c/a\u003e\n\nThis repository is released under the MIT license, which grants the following permissions:\n\n- Commercial use\n- Distribution\n- Modification\n- Private use\n\nFor more convoluted language, see the [LICENSE](https://github.com/darkguy10/NextJS-Electron-Boilerplate/blob/main/LICENSE.md).\n\n\u0026nbsp;\n\n### 📖 References\n\nInspirations taken from the famous [React+Electron Boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate) repo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDarkGuy10%2FNextJS-Electron-Boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDarkGuy10%2FNextJS-Electron-Boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDarkGuy10%2FNextJS-Electron-Boilerplate/lists"}