Guide · Open source

How to use electron-react-boilerplate: install, run and package

Updated 2026-10-29 · written with AI from the project's own documentation and checked against our catalogue data

Electron React Boilerplate is a pre-configured project template that combines Electron, React and React Router, with electron-vite and React Fast Refresh for the development workflow. It gives you a working starting point so you can write app code instead of wiring up the build tooling yourself. This guide walks through cloning the project, starting it in development and packaging it for your local platform.

Electron React Boilerplateelectron-react-boilerplate/electron-react-boilerplate · ★ 24.3k · MIT Install options & downloads

Quick start

1Check prerequisites. Confirm you have Node.js 24 or newer, npm 10 or newer and git installed.
2Clone the repository. Run the git clone command with --depth 1 and --branch main, naming the target folder for your project.
3Enter the project folder. Change into the folder you just cloned.
4Install dependencies. Run npm install to fetch the project's dependencies.
5Start development. Run npm start to launch the app in the dev environment.
6Package for your platform. Run npm run package to build a package for the local platform.

What do you need before you install it?

The README says the project requires Node.js 24 or newer and npm 10 or newer. You also need git, since the install step clones the repository.

The README assumes familiarity with Node.js and npm, and the project is aimed at developers who already know React.

Node.js 24 or newer
npm 10 or newer
git

How do you install electron-react-boilerplate?

Clone the repository with a shallow clone of the main branch, enter the project folder and install the dependencies. The clone command takes your project name as the target folder.

If installation fails, the README points to a debugging guide in the project's issue tracker. The compiler tooling notes in the repository explain the separate tooling install.

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

How do you start the app in development?

Run npm start from the project folder to launch the app in the dev environment. The README uses this as the main development command.

The README also names React Fast Refresh and electron-vite as part of the development workflow.

npm start

How do you package the app for production?

To package the app for the local platform, run the package script. The README describes this as packaging for production on your current operating system.

For full documentation on installation and other topics, the README links to the project's docs site.

npm run package

What is included in the template?

The template ships with Electron for building desktop apps with web technologies, React, React Router, electron-vite and React Fast Refresh already set up. The project is written in TypeScript and released under the MIT licence.

The project's stated goal is to save you from configuring Webpack, Babel and ESLint for Electron yourself, so you can start on app code sooner.

Electron for the desktop shell
React and React Router for the UI and routing
electron-vite and React Fast Refresh for development
TypeScript as the implementation language

Who should avoid this template?

If you only need a website or web app with no desktop packaging, this template is not the right fit, since it is specifically for Electron desktop apps. Beginners new to both React and JavaScript will also find the README assumes more background than they have.

The README points to ongoing maintenance and a roadmap that may change the setup, so teams that need an unchanging template should weigh that before adopting it.

What people use it for

Building a cross-platform desktop app with React and web technologies
Starting a new Electron project with a maintained, pre-wired setup
Skipping manual Webpack, Babel and ESLint configuration for an Electron app

Frequently asked questions

Is electron-react-boilerplate free to use?

The project is released under the MIT licence, as stated in the repository summary. Check the LICENSE file in the repository for the full terms before you use it in a commercial product.

What do I need to install electron-react-boilerplate?

The README requires Node.js 24 or newer and npm 10 or newer, plus git to clone the repository. Install those first, then run the three commands in the install section.

How do I start electron-react-boilerplate?

Run npm start from the project folder after npm install has finished. This starts the app in the dev environment.

How do I package an electron-react-boilerplate app?

Run npm run package to package the app for your local platform. The README describes this as the production packaging step.

Is electron-react-boilerplate good for beginners?

The README assumes familiarity with Node.js and npm, and the project targets developers who know React. Beginners new to both React and JavaScript should learn the basics first.

How does electron-react-boilerplate compare to Electron Forge, electron-vite and Tauri?

Electron Forge, electron-vite and Tauri are comparable projects. This template bundles Electron, React, React Router and electron-vite together as a starting point, while the others cover parts of the same space. Compare them against your needs, since this guide does not benchmark them.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Choose electron-react-boilerplate if you already know React and want a maintained, pre-wired starting point for a cross-platform desktop app. Pick something else if you only need a web app, you are new to React and JavaScript, or you need a template that will not change over time.

Install options & downloads