blob: 3cb04b6e98ed5c42e19fa79e8f2e64bae0d68541 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
# electron-react-redux-boilerplate
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/bradstewart/electron-devtools-installer)
* [Mocha](https://mochajs.org/)
* [Browsersync](https://browsersync.io/)
## Quick start
Clone the repository
```bash
git clone git@github.com:jschr/electron-react-redux-boilerplate.git
```
Install dependencies
```bash
cd electron-react-redux-boilerplate
npm install
```
Development
```bash
npm run develop
```
## DevTools
Toggle DevTools:
* OSX: <kbd>Cmd</kbd> <kbd>Alt</kbd> <kbd>I</kbd> or <kbd>F12</kbd>
* Linux: <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>I</kbd> or <kbd>F12</kbd>
* Windows: <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>I</kbd> or <kbd>F12</kbd>
## Packaging
Modify [electron-builder.yml](./electron-builder.yml) to edit package info.
For a full list of options see: https://github.com/electron-userland/electron-builder/wiki/Options.
Create a package for OSX, Windows and Linux
```
npm run pack
```
Or target a specific platform
```
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)
|
