Skip to content

luccasfr/electron-boilerplate

Repository files navigation

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". Default

  2. With custom title-bar. (branch: custom-title-bar) Custom

In case you want this second option, you can clone the branch with it:

git clone -b custom-title-bar https://github.com/luccasfr/electron-boilerplate

How to get started?

  1. Install dependencies
npm install
  1. Start the project
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.

Authors

Lucas Ferreira

About

Boilerplate for Electron apps with file-based router, tailwind, shadcn/ui, and many more.

Topics

Resources

Stars

13 stars

Watchers

1 watching

Forks

Contributors