https://github.com/luccasfr/electron-boilerplate
Boilerplate for Electron apps with file-based router, tailwind, shadcn/ui, and many more.
https://github.com/luccasfr/electron-boilerplate
electron-forge react shadcn-ui tailwindcss tanstack-router typescript vite
Last synced: about 2 months ago
JSON representation
Boilerplate for Electron apps with file-based router, tailwind, shadcn/ui, and many more.
- Host: GitHub
- URL: https://github.com/luccasfr/electron-boilerplate
- Owner: luccasfr
- Created: 2024-05-11T22:07:39.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-07T22:01:47.000Z (over 1 year ago)
- Last Synced: 2025-03-07T22:28:35.841Z (over 1 year ago)
- Topics: electron-forge, react, shadcn-ui, tailwindcss, tanstack-router, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 1.57 MB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Electron Boilerplate
## What's included out-of-the-box?
- Electron Forge
- Vite
- React
- TailwindCSS
- shadcn/ui
- Full Typescript support
- Tanstack file-based router
## There are two options
1. With the system title-bar which is the "default".
2. With custom title-bar. (branch: `custom-title-bar`)
In case you want this second option, you can clone the branch with it:
```bash
git clone -b custom-title-bar https://github.com/luccasfr/electron-boilerplate
```
## How to get started?
1. Install dependencies
```bash
npm install
```
2. Start the project
```bash
npm start
```
## How to create new routes?
Just push new routes into `app` dir and `@tanstack/router-vite-plugin` will do the job, generating the `routeTree.gen.ts` file.
In case of doubts, follow the doc's.
To check **filename conventions**, follow this [link](https://tanstack.com/router/latest/docs/framework/react/guide/file-based-routing#file-naming-conventions).
## Authors
