Just a boilerplate ready to be themed. I found myself needing a similar setup for multiple applications.
- Electron React Boilerplate
- styled-components
- MaterialUI + MaterialUI/Icons
- electron-settings
- frameless-titlebar
To theme the application I use a combo of styled-components' ThemeProvider
& MaterialUI's MuiThemeProvider
with
some additional properties added to the base theme object provided by createMuiTheme()
in order to then style/customize the application's frameless-titlebar.
A boilerplate for Scalable Cross-Platform Desktop Apps based on Electron, React, Redux, React Router, Webpack and React Hot Loader for rapid application development (HMR).
- If you have installation or compilation issues with this project, please see our debugging guide
First, clone the repo via git:
git clone --depth 1 --single-branch --branch master https://github.com/electron-react-boilerplate/electron-react-boilerplate.git your-project-name
And then install the dependencies with yarn.
$ cd your-project-name
$ yarn
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
If you don't need autofocus when your files was changed, then run dev
with env START_MINIMIZED=true
:
$ START_MINIMIZED=true yarn dev
To package apps for the local platform:
$ yarn package
To package apps for all platforms:
First, refer to the Multi Platform Build docs for dependencies.
Then,
$ yarn package-all
To package apps with options:
$ yarn package --[option]
To run End-to-End Test
$ yarn build-e2e
$ yarn test-e2e
# Running e2e tests in a minimized window
$ START_MINIMIZED=true yarn build-e2e
$ yarn test-e2e
๐ก You can debug your production build with devtools by simply setting the DEBUG_PROD
env variable:
DEBUG_PROD=true yarn package
This boilerplate is configured to use css-modules out of the box.
All .css
file extensions will use css-modules unless it has .global.css
.
If you need global styles, stylesheets with .global.css
will not go through the
css-modules loader. e.g. app.global.css
If you want to import global css libraries (like bootstrap
), you can just write the following code in .global.css
:
@import '~bootstrap/dist/css/bootstrap.css';
If you want to use Sass in your app, you only need to import .sass
files instead of .css
once:
import './app.global.scss';
This project comes with Flow support out of the box! You can annotate your code with types, get Flow errors as ESLint errors, and get type errors during runtime during development. Types are completely optional.
If your application is a fork from this repo, you can add this repo to another git remote:
git remote add upstream https://github.com/electron-react-boilerplate/electron-react-boilerplate.git
Then, use git to merge some latest commits:
git pull upstream master
Support us with a monthly donation and help us continue our activities. [Become a backer]
Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]
MIT ยฉ Electron React Boilerplate