This project was bootstrapped with electron-cra-boilerplate.
Using Create React App (Typescript) + Electron + Electron Forge
$ git clone https://github.com/fm-labs/electron-cra-boilerplate.git my-electron-app
$ cd my-electron-app
$ yarn install
! You can also use npm instead of yarn !
Runs the Electron app and the Webpack development server for the React app. Changes in the React app source code, should be automatically updated in the Electron app.
$ yarn run dev
Creates an Electron app package. Output is stored in out/.
$ yarn run package
// change to the output directory
// depending on your operating system, cpu architecture or electron-forge configuration
// the path might be different.
$ cd ./out/electron-cra-boilerplate-linux-x64
// run the packaged app
$ ./electron-cra-boilerplate
In the project directory, you can run:
Runs the Electron app and the React app in development mode. The electron app will open automatically with browser-devtools and react-devtools attached.
This command starts the webpack dev server and the electron app concurrently.
Runs the Electron app in development mode. The electron app will open automatically with browser-devtools and react-devtools attached.
Creates an Electron app package.
By default the packaged app is saved in the out/ directory.
Takes a packaged Electron application and outputs a certain kind of distributable
Runs eslint and print errors/warnings to console
Runs eslint and fix errors/warnings in source code files.
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Launches the testrunner and exits after tests have been completed.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
$ npm i -g yarn
Solution for Ubuntu/Debian users: Install rpm package
$ sudo apt install rpm
- Create React App documentation
- React documentation
- Electron Documentation
- Electron Forge Documentation
- Electron Packager Documentation
- Remove src from final Electron package
- Disable source maps generation for production builds of react app
- App icon
- React Dev Tools
- ASAR support
- ESLint
- Prettier
- GitHub Actions Workflow for
- testing
- building
- packaging
- making
- npm/yarn scripts to make specific electron-forge maker targets
- Travis support
- Badges