Skip to content

YeonV/Vitron

Repository files navigation

Vitron | SuperCharged Starter

docs docs docs docs docs docs

logo

logo

Overview

click to show
  • based on vite-react-electron
    (check the readme!)

  • inspired by Nextron

  • implemented custom-electron-titlebar
    (activate/deactivate via package.json)

  • added Nextron's IPC communication example
    (for sync and async messaging)

  • implemented Material UI
    (incl. ThemeProvider & dynamic createTheme)

  • implemented Zustand
    (incl. typed store via Typescript)

  • implemented React Router

  • created example for included electron-store
    (incl. sync & IPC-messagning)

  • created proper Dark Mode, handling mui-Theme AND nativeTheme!
    (activate custom titlebar for awesome synergy)

  • added scripts to start and build the inner react project isolated

Tutorial

1. Init Project
  yarn create vitron

image

image

2. push it to your github

*optional but highly recommended to enjoy awesome features

3. Make some changes & push it

i.e. edit package.json and change author When pushing to github, the start of your commit message is important:

Git-Actions

  • If your commit message starts with "Release " then win, mac & linux binaries will be created and a new release is made based on your version set inside package.json, and including all commit-messages from last release to this release are added as release-text: like this

  • If your commit message startes with "web:", the inner react app is available under your repo's github-pages

  • If your commit message startes with "dev:" then this message will be excluded for the next release-text

4. Enjoy auto-generated releases with precompiled binaries for mac, win & linux

image

Screens

click to show
darkmode-app lightmode-app darkmode-web lightmode-web
drawing drawing drawing drawing

discord

creator creator

About

⚡Vite + :electron: Electron

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors