electron-react-ts

An Electron boilerplate with hot reloading for React and TypeScript.

📗 Usage

$ git clone https://github.com/sprout2000/electron-react-ts.git
$ cd electron-react-ts
$ npm install

# on development
$ npm run dev

# on production
$ npm run build

NOTE: You will need to have Node.js and Git installed.

👍 Features

• Supports hot reloading in both the main and renderer processes.
• No complicated pre-made settings.

The template provided by this scaffold is NOT an all-in-one. It provides only the necessary and sufficient settings so that you can customize it as you like. In other words, it has no "eject".

📸 Screen shots

Hot reload in renderer process

Hot reload in main process

📦 How to package your app to publish?

npm run build && npm run package

And then, you will find the installer in the release directory.

🎨 How to use sass (*.scss) in your project?

You will need to add sass and sass-loader:

npm install --save-dev sass sass-loader

And then, update your webpack.config.ts:

  module: {
    rules: [
      {
        test: /\.s?css$/,
        use: [MiniCssExtractPlugin.loader, "css-loader", "sass-loader"],
      },
    ],
  },

©️ Copyright

Copyright (c) 2022 sprout2000