Git Product home page Git Product logo

dead-simple-electron-react-vite's Introduction

Dead simple Electron & React & Vite

This is a sample project configuration for using Electron & React & Vite, minimized, simplest.

Electron-React-Vite

I do not like boilerplate, but I decided to create this because there are some details that need to be figured out in order to generate a minimum configuration project for Electron.

This project configuration will enable the following:

  • Electron.
  • Package generation with Electron-builder.
  • React.
  • Typescript.
  • Build with Vite and Hot Module Replacement.

This project has been carefully constructed to be "minimally structured". Thus, you should have less trouble knowing what is being used and how it is being used. Still, I am generating commits at each step of building the environment, in case later version upgrades make this code unworkable. This allows us to keep track of what truly needs to be done.

I have tried to deviate as little as possible from the standard Vite+React directory structure. Therefore, general React client-side development techniques may be applied as is.

NOTE: The central hub linking Vite and Electron is vite-plugin-electron. Without this Vite plugin, it would not have been so simple. Thanks for a great plugin.

How to use

Choose between two methods:

  • You can clone this repository,
    • Enter electron directory and npm install to install packages.
    • Then run your Electron app just npm run dev while editing the code.
  • Or manually apply it to your app, using the comments and diffs from each commit in this repository history as a guide.

To build a redistributable package, use npm run build.

Repository

This repository will always be such that the build sequence is shown at a minimum. This means that changes may be directly modified and rebased from previous commits, rather than normal committed sequentially.

License

CC0

dead-simple-electron-react-vite's People

Contributors

kekyo avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.