{"id":24437318,"url":"https://github.com/guasam/electron-react-webpack-typescript-2024","last_synced_at":"2025-02-25T10:15:24.888Z","repository":{"id":40638750,"uuid":"265288492","full_name":"guasam/electron-react-webpack-typescript-2024","owner":"guasam","description":"Electron React Webpack Typescript Boilerplate with Custom Window and Titlebar Menus.","archived":false,"fork":false,"pushed_at":"2025-01-28T01:36:45.000Z","size":3536,"stargazers_count":368,"open_issues_count":0,"forks_count":80,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-18T09:15:03.238Z","etag":null,"topics":["boilerplate","electron","electron-boilerplate","electron-custom-titlebar","electron-react","electron-react-boilerplate","electron-react-template","electron-react-typescript-template","electron-titlebar-menu","electron-webpack","electron-window","erwt-boilerplate","react","secure-electron-template","typescript","webpack"],"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/guasam.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":null,"patreon":null,"open_collective":null,"ko_fi":"guasam","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2020-05-19T15:37:00.000Z","updated_at":"2025-02-18T07:25:42.000Z","dependencies_parsed_at":"2022-08-09T23:50:48.163Z","dependency_job_id":"afa05ac7-5266-40b5-8dbd-651b22323547","html_url":"https://github.com/guasam/electron-react-webpack-typescript-2024","commit_stats":null,"previous_names":["codesbiome/electron-react-webpack-typescript-2020","codesbiome/electron-react-webpack-typescript-2023","guasam/electron-react-webpack-typescript-2024","codesbiome/electron-react-webpack-typescript-2024"],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guasam%2Felectron-react-webpack-typescript-2024","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guasam%2Felectron-react-webpack-typescript-2024/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guasam%2Felectron-react-webpack-typescript-2024/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guasam%2Felectron-react-webpack-typescript-2024/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guasam","download_url":"https://codeload.github.com/guasam/electron-react-webpack-typescript-2024/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240645307,"owners_count":19834397,"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-boilerplate","electron-custom-titlebar","electron-react","electron-react-boilerplate","electron-react-template","electron-react-typescript-template","electron-titlebar-menu","electron-webpack","electron-window","erwt-boilerplate","react","secure-electron-template","typescript","webpack"],"created_at":"2025-01-20T18:16:00.626Z","updated_at":"2025-02-25T10:15:24.855Z","avatar_url":"https://github.com/guasam.png","language":"TypeScript","funding_links":["https://ko-fi.com/guasam"],"categories":[],"sub_categories":[],"readme":"# Electron React Webpack Typescript - ERWT\n\nA ready-to-go setup for building desktop apps with Electron, React, Webpack, and TypeScript. It’s got hot-reload, custom import aliases, and makes it easy to create executable builds for sharing.\n\n\u003cbr\u003e\n\u003cimg src=\"assets/images/anim_v8.gif\" /\u003e\n\u003cbr\u003e\n\n## Core Features\n\n- 🌟 **Electron** – *Build desktop apps with ease.*  \n- 🌀 **TypeScript** – *Type-safe coding made simple.*  \n- ⚛️ **React** – *For smooth and modern UIs.*  \n- 🥗 **SASS/SCSS Loader** – *Style it your way.*  \n- 🎨 **CSS Loader** – *Handle styles effortlessly.*  \n- 📸 **Image Loader** – *Easy image imports.*  \n- 🆎 **Font Loader** – *Add custom fonts easily.*  \n- 🧹 **ESLint** – *Keep your code clean and tidy.*  \n- 📦 **Electron Forge** – *Hassle-free builds and packaging.*  \n- 📐 **Custom Window Design** – *Frame, titlebar, and menubar your way.*  \n- 🔱 **Webpack Config** – *Optimized and customizable builds.*  \n- 🧩 **Path Aliases** – *Keep your code organized.*  \n- 🗡️ **Native Modules Support** – *Use Node.js modules seamlessly.*  \n- 🔥 **Fast Refresh \u0026 HMR** – *Instant updates while coding.*  \n- 🌞 **Dark/Light Mode** – *Built-in themes to switch it up.*  \n- 🎁 **Package Bundling** – *Share your app easily.*  \n\n\u003cbr\u003e\n\n## Custom Electron Window Titlebar \u0026 Menus\n\nThis project uses [electron-window](https://github.com/guasam/electron-window) to power custom window components and features.  \n\n**Here’s what it offers:**\n\n- Customizable titlebar for your Electron app.  \n- Easy platform-specific controls for max/min/close buttons—just set the `platform` prop (`windows` or `mac`) in `\u003cWindowFrame\u003e`.  \n- Show or hide the titlebar menus by pressing the `alt` or `option` key.  \n- The `title` prop shows up in the center of the titlebar when menus are hidden.  \n- Edit menu entries in the `src/main/window/titlebarMenus.ts` file.  \n- Customize UI, colors, or window controls by tweaking the `src/renderer/window` components and styles.  \n\n\n\u003cbr\u003e\n\n## Custom Aliases for Paths\n\nThis project includes predefined aliases to simplify `import` paths. Here’s the list:  \n\n| **Alias**      | **Target Path**              |  \n| --------------- | --------------------------- |  \n| `@assets`       | `/assets`                   |  \n| `@main`         | `/src/main`                 |  \n| `@renderer`     | `/src/renderer`             |  \n| `@common`       | `/src/common`               |  \n| `@src`          | `/src`                      |  \n| `@styles`       | `/src/renderer/styles`      |  \n| `@components`   | `/src/renderer/components`  |  \n\n\n\u003cbr\u003e\n\n## Installation\n\n![status](https://img.shields.io/badge/ERWT-Main%20Version-blue.svg)\n\nThe default branch of the project has a clean structure with separate contexts for `main` and `renderer`, plus custom windows, titlebars, and more.  \n\n```bash\ngit clone https://github.com/guasam/electron-react-webpack-typescript-2024\n```\n\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003cb\u003eOR\u003c/b\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\n![status](https://img.shields.io/badge/ERWT-Minimal%20Version-0a922a.svg)\n\nThe minimal version of ERWT has a super simple project structure \"wihtout\" any custom windows, titlebars, or menus. \n\n```bash\ngit clone -b minimal https://github.com/guasam/electron-react-webpack-typescript-2024\n```\n\n\u003cbr\u003e\n\nInstall dependencies using [pnpm](https://pnpm.io/) or [yarn](https://www.npmjs.com/package/yarn) or [npm](https://www.npmjs.com/) :\n\n```bash\n# using pnpm\npnpm install\n\n# or using yarn\nyarn install\n\n# or using npm\nnpm install\n```\n\n\u003cbr /\u003e\n\n## Start : Development\n\nTo get started with development and run your app, just use this command:\n\n```bash\nyarn start\n```\n\n\u003cbr /\u003e\n\n## Lint : Development\n\nTo lint your application’s source code with ESLint, run this:\n\n```bash\nyarn lint\n```\n\n\u003cbr /\u003e\n\n## Package : Production\n\nPackage your Electron app into OS-specific bundles (.app, .exe, etc) like this:\n\n```bash\nyarn package\n```\n\n\u003cbr /\u003e\n\n## Make : Production\n\nMaking takes your packaged app and creates platform-specific distributables, like DMG, EXE, or Flatpak files (and more).\n\n```bash\nyarn make\n```\n\n\u003cbr /\u003e\n\n## Publish : Production\n\nPublishing takes the artifacts generated by the `make` command and uploads them to a service, so you can distribute or use them for updates (like an update server or an S3 bucket).\n\n```bash\nyarn publish\n```\n\n\u003cbr /\u003e\n\n## Packager \u0026 Makers Configuration\n\nThis makes it easy to configure your packaged app and create platform-specific distributables, like DMG, EXE, or Flatpak files.\n\nThis configurations file is available in :\n\n```bash\ntools/forge/forge.config.js\n```\n\nFor further information about packager, you can visit [Electron Forge Configuration](https://www.electronforge.io/configuration)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguasam%2Felectron-react-webpack-typescript-2024","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguasam%2Felectron-react-webpack-typescript-2024","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguasam%2Felectron-react-webpack-typescript-2024/lists"}