Skip to content

aFrontendDev/electron-react

Repository files navigation

Electron React Boilerplate

This is a modified version of the electron-react-boilerplate.

The only real difference with this version is to the contents of the 'app' itself in how it's scaffolded.

  • components self contained with styling, testing and tsx file in one place
  • favour scss modules with postcss (for pxToRem) for styling
  • layout system added
  • couple of generic modules added to start with
  • additional examples added, the redux setup updated a little to reflect this
  • app can be opened in browser now if desired

Electron React Boilerplate uses Electron, React, Redux, React Router, Webpack and React Hot Loader for rapid application development (HMR).


Install

First, clone the repo via git and install dependencies:

git clone --depth 1 --single-branch https://github.com/aFrontendDev/electron-react.git
your-project-name
cd your-project-name
yarn

Starting Development

Start the app in the dev environment. This starts the renderer process in hot-module-replacement mode and starts a webpack dev server that sends hot updates to the renderer process:

yarn dev

Starting Prod version of app

Start the app in production mode:

yarn start

Run unit tests

Jest and Enzyme are the default testing tools in this boilerplate, to run tests:

yarn test

Packaging for Production

To package apps for the local platform:

yarn package

This creates a release folder at root which contains the executables.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •