/electron-react-boilerplate

A Foundation for Scalable Cross-Platform Apps

Primary LanguageTypeScriptMIT LicenseMIT


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


Build Status Github Tag

OpenCollective OpenCollective StackOverflow

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

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

License

MIT © Electron React Boilerplate