https://github.com/burhanuday/electron-react-boilerplate

Electron and Create React App boilerplate without any complex setup
https://github.com/burhanuday/electron-react-boilerplate

boilerplate boilerplate-react boilerplate-template create-react-app electron electron-app react reactjs

Last synced: 15 days ago
JSON representation

Electron and Create React App boilerplate without any complex setup

• Host: GitHub
• URL: https://github.com/burhanuday/electron-react-boilerplate
• Owner: burhanuday
• License: mit
• Created: 2019-06-23T15:00:27.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T18:53:00.000Z (almost 2 years ago)
• Last Synced: 2024-05-28T16:14:25.983Z (6 months ago)
• Topics: boilerplate, boilerplate-react, boilerplate-template, create-react-app, electron, electron-app, react, reactjs
• Language: JavaScript
• Homepage:
• Size: 2.22 MB
• Stars: 21
• Watchers: 4
• Forks: 3
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![header](./src/assets/images/header.png)

# Electron Create React App

A boilerplate with zero dependencies other than React. Easy to use with single command run and packaging scripts

## Usage

- Clone this repository

- `cd` into the directory and delete git files `rm -rf .git`

- Run `npm install`

## Development

- Run `npm start` to start electron and react concurrently

## Build and package

- Run `npm run package` to compile react, copy files and then package your app

- A new `dist` folder will be created in the root of your project containing the executable files

- NOTE: add `--mac` to the `postpackage` script besides `--win` if you are on a mac computer

## Project structure

- `electron/`: Code for the main Electron process

- `src/react/`: Code for the React renderer process

- `src/shared/`: Code shared between React and Electron

- `package.json`: Contains scripts for running the app in development, building it, and packaging it for production using electron-builder

## Contributing

Open a new PR to contribute

## Credits

Original idea by [johndyer24](https://github.com/johndyer24)

## License

MIT