https://github.com/jschr/electron-react-redux-boilerplate

A minimal boilerplate to get started with Electron, React and Redux.
https://github.com/jschr/electron-react-redux-boilerplate

boilerplate electron react redux

Last synced: about 2 months ago
JSON representation

A minimal boilerplate to get started with Electron, React and Redux.

• Host: GitHub
• URL: https://github.com/jschr/electron-react-redux-boilerplate
• Owner: jschr
• Created: 2015-09-14T16:44:57.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:32:25.000Z (over 1 year ago)
• Last Synced: 2024-06-12T15:54:30.182Z (3 months ago)
• Topics: boilerplate, electron, react, redux
• Language: JavaScript
• Homepage:
• Size: 1.48 MB
• Stars: 554
• Watchers: 23
• Forks: 131
• Open Issues: 19
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-github-repos - jschr/electron-react-redux-boilerplate - A minimal boilerplate to get started with Electron, React and Redux. (JavaScript)

README

        
# electron-react-redux-boilerplate

[![Build Status](https://api.travis-ci.org/jschr/electron-react-redux-boilerplate.svg)](https://travis-ci.org/jschr/electron-react-redux-boilerplate)

[![dependencies Status](https://david-dm.org/jschr/electron-react-redux-boilerplate/status.svg)](https://david-dm.org/jschr/electron-react-redux-boilerplate)

[![devDependencies Status](https://david-dm.org/jschr/electron-react-redux-boilerplate/dev-status.svg)](https://david-dm.org/jschr/electron-react-redux-boilerplate?type=dev)

A minimal boilerplate to get started with [Electron](http://electron.atom.io/), [React](https://facebook.github.io/react/) and [Redux](http://redux.js.org/).

Including:

* [React Router](https://reacttraining.com/react-router/)

* [Redux Thunk](https://github.com/gaearon/redux-thunk/)

* [Redux Actions](https://github.com/acdlite/redux-actions/)

* [Redux Local Storage](https://github.com/elgerlambert/redux-localstorage/)

* [Electron Packager](https://github.com/electron-userland/electron-packager)

* [Electron DevTools Installer](https://github.com/MarshallOfSound/electron-devtools-installer)

* [Electron Mocha](https://github.com/jprichardson/electron-mocha)

* [Browsersync](https://browsersync.io/)

## Quick start

Clone the repository

```bash

git clone --depth=1 https://github.com/jschr/electron-react-redux-boilerplate

```

Install dependencies

```bash

cd electron-react-redux-boilerplate

npm install

```

Development

```bash

npm run develop

```

## DevTools

Toggle DevTools:

* macOS: Cmd Alt I or F12

* Linux: Ctrl Shift I or F12

* Windows: Ctrl Shift I or F12

## Packaging

Modify [electron-builder.yml](./electron-builder.yml) to edit package info.

For a full list of options see: https://www.electron.build/configuration/configuration

Create a package for macOS, Windows or Linux using one of the following commands:

```

npm run pack:mac

npm run pack:win

npm run pack:linux

```

## Tests

```

npm run test

```

## Maintainers

- [@jschr](https://github.com/jschr)

- [@pronebird](https://github.com/pronebird)

## Apps using this boilerplate

- [Mullvad VPN app](https://github.com/mullvad/mullvadvpn-app)

- [YouTube Downloader Electron](https://github.com/vanzylv/youtube-downloader-electron)

- [Martian: A Websocket test tool](https://github.com/drex44/martian)