https://github.com/daltonmenezes/electron-app
💅 An Electron app boilerplate with React 19, TypeScript 5, Tailwind 4, shadcn/ui, Electron Vite, Biome, GitHub Action releases and more.
https://github.com/daltonmenezes/electron-app
boilerplate css electron electron-builder esbuild eslint github-actions hacktoberfest nodejs prettier react reactjs sass template typescript vite
Last synced: 15 days ago
JSON representation
💅 An Electron app boilerplate with React 19, TypeScript 5, Tailwind 4, shadcn/ui, Electron Vite, Biome, GitHub Action releases and more.
- Host: GitHub
- URL: https://github.com/daltonmenezes/electron-app
- Owner: daltonmenezes
- License: mit
- Created: 2022-02-17T12:38:52.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-04T01:21:06.000Z (about 2 months ago)
- Last Synced: 2025-04-02T04:01:36.256Z (23 days ago)
- Topics: boilerplate, css, electron, electron-builder, esbuild, eslint, github-actions, hacktoberfest, nodejs, prettier, react, reactjs, sass, template, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 2.53 MB
- Stars: 567
- Watchers: 7
- Forks: 41
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Electron App
💅 An Electron app boilerplate with React v19, TypeScript v5, Tailwind v4, shadcn/ui, Electron Vite, Biome, GitHub Action releases and more.
# Features
- **Stands out**
- 🔥 Fast and Ready-to-go with a well-thought-out structure
- 🚀 Auto reload for main and **Fast Refresh** for renderer process
- 🎉 Window/Screen routing included
- 😎 Preload (context bridge) already configured
- 🔮 GitHub Action releases with `Windows`, `Mac` and `Linux` binaries
- 🔒 Source Code Protection support
- 🍪 Absolute paths support
- **Technologies**:
- 🔋 Electron
- 🔥 ReactJS v19
- 🌎 React Router DOM v7 and Electron Router DOM v2
- 🧐 React Developer Tools
- 🔍 Code inspector (holding `Alt` or `Option` key on DOM element and clicking on it)
- 💙 TypeScript v5
- 📦 Electron Vite
- ✨ TailwindCSS v4
- 🎨 shadcn/ui
- 🍦 lucide-icons
- 💫 Biome / EditorConfig
- 📦 Electron Builder
- 🔮 action-electron-builder
> :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!
# Requirements
- [Node.js 20](https://nodejs.org/en/download/)
- [pnpm 10](https://pnpm.io/installation)
# Installation
```bash
npx degit daltonmenezes/electron-app/template project_name
```
```bash
cd project_name
pnpm install
pnpm dev
```
Now, look at the **package.json** file in the root directory, you should update some of that settings with your project branding.
# Adding new dependencies
For security reasons, **pnpm** has the [onlyBuiltDependenciesFile](https://pnpm.io/package_json#pnpmonlybuiltdependenciesfile) property where only
dependencies 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.
# Distribution
### For all platforms
> **Note**: Check [Electron Builder docs](https://www.electron.build/cli) for more knowledge
```
pnpm build
```
### For a specific one
```bash
pnpm build --mac
# OR
pnpm build --win
# OR
pnpm build --linux
```
The builded apps will be available in the `dist` folder.
# Documents
Running released unsigend apps
FAQ - Frequently Asked Questions
# Contributing
> **Note**: contributions are always welcome, but always **ask first**, — please — before work on a PR.
That said, there's a bunch of ways you can contribute to this project, like by:
- :beetle: Reporting a bug
- :page_facing_up: Improving this documentation
- :rotating_light: Sharing this project and recommending it to your friends
- :dollar: Supporting this project on GitHub Sponsors or Patreon
- :star2: Giving a star on this repository
# License
[MIT © Dalton Menezes](https://github.com/daltonmenezes/electron-app/blob/main/LICENSE)