Electron React Boilerplate ORG

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

[![Build Status][github-actions-status]][github-actions-url]
[![Github Tag][github-tag-image]][github-tag-url]

[![StackOverflow][stackoverflow-img]][stackoverflow-url]

Install

Clone the repo and install dependencies:

bash
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:

bash
npm start

Packaging for Production

To package apps for the local platform:

bash
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

[github-actions-status]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/workflows/Test/badge.svg
[github-actions-url]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/actions
[github-tag-image]: https://img.shields.io/github/tag/electron-react-boilerplate/electron-react-boilerplate.svg?label=version
[github-tag-url]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/releases/latest
[stackoverflow-img]: https://img.shields.io/badge/stackoverflow-electron_react_boilerplate-blue.svg
[stackoverflow-url]: https://stackoverflow.com/questions/tagged/electron-react-boilerplate

Collapse