This project has been tested on Windows 7 & 10 using the following versions without any errors. Newer versions are also likely to work but you can always fallback to the version number specified.
-
npm (v3.10.3) installed automatically with NodeJS
-
Atom text editor with the recommended packages found in the Notes section
-
Run the following command
-> npm install
-> npm run dev
-> npm run production
This bundles the react part of the application into a bundle and minifies the electron part together into a /dist directory. It also starts up the bundled code. Please note that this doesn't have hot reloading capabilites.
To package the /dist folder into an executable file you can run:
-> npm run build-windows
Currently this is the only build and it targets 64bit windows.
The project is based on the following Github repository: chentsulin/electron-react-boilerplate
- Electron documentation
- React Components
- ESLint general rules
- ESLint react rules
- Electron Fundamentals course
- Electron app using bluetooth - JSConf
-
Be aware that certain packages that this project depends on are subject to updates and could potentially break this build. If this is the case you can either revert said packages to the version specified in the
package.json
file by removing the^
from the version number or by trying to fix the errors caused by the update. -
I recommend the following community packages for atom:
-
Other cool community packages for atom:
-
To change the PORT edit the
config
inpackage.json
. If you're not building on windows you might also have to change any use of%npm_package_config_*%
to$npm_package_config_*