This is a template for building a desktop application using Electron, Vite, React, and Express. It is a full-stack application that uses Electron to run the React frontend and Express backend. The frontend is built using Vite, and the backend is built using Express.
The build will generate a standalone desktop application that can be run on Windows, macOS, and Linux.
- Clone the repository
- Run
npm installto install the dependencies cd frontendand runnpm installto install the frontend dependencies- You may need to run
npm run buildin thefrontendfolder to build the frontend. - Run
npm run devto start the development server - React app will be running on http://localhost:5173
- Run
npm run buildto build the installers - The installers will be generated in the
distfolder
- Run
electron-builder build --macto build the macOS installer - Run
electron-builder build --winto build the Windows installer - Run
electron-builder build --linuxto build the Linux installer
Installers will be generated in the dist folder.
- The github action that's supposed to build the installers, builds a broken
.dmgfile, due to it not being signed.
The action triggers on a new tag created with the format v*.*.*. It will build the installers and upload them as release assets.
git tag v1.0.0 # Create a new tag
git push origin v1.0.0 # Push the tag to GitHub