electron-starter-kit

A Boilerplate for an Easy Start with TypeScript, React, and Electron

Electron application boilerplate based on React, Redux, and Webpack for rapid application development using TypeScript.

Install

Clone the repository with Git:

git clone --depth=1 git@github.com:kendrickw/electron-starter-kit.git <your-project-name>

And then install the dependencies:

cd <your-project-name>
yarn

Usage

Both processes have to be started simultaneously in different console tabs:

yarn run start-renderer-dev
yarn run start-main-dev

This will start the application with hot-reload so you can instantly start developing your application.

You can also run do the following to start both in a single process:

yarn run dev

Packaging

We use Electron builder to build and package the application. By default you can run the following to package for your current platform:

yarn run dist

This will create a installer for your platform in the releases folder.

You can make builds for specific platforms (or multiple platforms) by using the options found here. E.g. building for all platforms (Windows, Mac, Linux):

# Create distribution for Mac, Windows and Linux
yarn run dist -- -mwl

Prettier

To change the code style, you can change the configuration in .prettierrc.

To fix all lint errors run yarn lint-staged.

About this project

This project was set up from scratch but is heavily influenced by the Electron React Boilerplate project and React Redux TypeScript guide.

License

MIT