Electron React Boilerplate Quick Starter

Quick starter for Electron React Boilerplate featuring

• dotenv : use .env file for dev, .env.prod for production
• Internationalization (i18next + react-i18next) and folder structure
• CSS : styled-components & tailwindcss (postcss postcss-loader autoprefixer) & rippleui
• IPC communication ready (bidirectional & unidirectional) with controllers and models
• Configuration for dev and prod webpack with tailwind
• Eslint and Prettier custom configuration

Start :

Configuration before starting :

package.json :

• build.productName : product name
• build.appId : app Id (ex : com.domain.appName)
• build.publish[0].url : link to the cloud directory where app versions are stored alongside with latest.yml file
• build.publish[1].owner, repo : github informations

Environment variables

Use .env file for dev mode, .env.prod is then used for the production build (package)

Set :

• AUTO_UPDATE_FEED_URL : url to your public folder where your app versions and latest.yml files are stored
• Any other variable you may need

Build :

Configuration before building :

/release/app/package.json :

• name : name of the app
• version : version of the current build (to increment each time you build a new major or minor version of the app)
• description : description of the app
• author : author informations

Building

Build the app (installer):

npm run package

Output folder is /release/app/build

---

Publish the build to your providers (github as configured by default):

npm run publish

---

Electron React Boilerplate README.md

Electron React Boilerplate uses Electron, React, React Router, Webpack and React Fast Refresh.

Install

Clone the repo and install dependencies:

git clone --depth 1 --branch main https://github.com/electron-react-boilerplate/electron-react-boilerplate.git your-project-name
cd your-project-name
npm install

Having issues installing? See our debugging guide

Starting Development

Start the app in the dev environment:

npm start

Packaging for Production

To package apps for the local platform:

npm run package

Docs

See our docs and guides here

Community

Join our Discord: https://discord.gg/Fjy3vfgy5q

Sponsors

Donations

Donations will ensure the following:

• 🔨 Long term maintenance of the project
• 🛣 Progress on the roadmap
• 🐛 Quick responses to bug reports and help requests

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

Maintainers

• Amila Welihinda
• John Tran
• C. T. Lin
• Jhen-Jie Hong

License

MIT © Electron React Boilerplate