Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanjudis/alice-generator
https://github.com/stefanjudis/alice-generator
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/stefanjudis/alice-generator
- Owner: stefanjudis
- License: mit
- Created: 2016-01-27T08:36:40.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-01-31T14:02:35.000Z (almost 9 years ago)
- Last Synced: 2024-04-15T03:17:46.654Z (7 months ago)
- Language: JavaScript
- Size: 593 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# electron-react-boilerplate
[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Dependency Status][david_img]][david_site]
> Live editing development on desktop app
[Electron](http://electron.atom.io/) application boilerplate based on [React](https://facebook.github.io/react/), [Redux](https://github.com/rackt/redux), [React Router](https://github.com/rackt/react-router), [Webpack](http://webpack.github.io/docs/), [React Transform HMR](https://github.com/gaearon/react-transform-hmr) for rapid application development
## Screenshot
## Install
Install dependencies.
```bash
$ npm install
```
## Run
Run this two commands __simultaneously__ in different console tabs.
```bash
$ npm run hot-server
$ npm run start-hot
```
*Note: requires a node version >= 4 and an npm version >= 2.*
#### Toggle Chrome DevTools
- OS X: Cmd Alt I or F12
- Linux: Ctrl Shift I or F12
- Windows: Ctrl Shift I or F12
*See [electron-debug](https://github.com/sindresorhus/electron-debug) for more information.*
#### Toggle Redux DevTools
- All platforms: Ctrl+H
*See [redux-devtools-dock-monitor](https://github.com/gaearon/redux-devtools-dock-monitor) for more information.*
## Externals
If you use any 3rd party libraries which can't be built with webpack, you must list them in your `webpack.config.base.js`：
```javascript
externals: [
// put your node 3rd party libraries which can't be built with webpack here (mysql, mongodb, and so on..)
]
```
You can find those lines in the file.
## CSS Modules support
Import css file as [css-modules](https://github.com/css-modules/css-modules) using `.module.css`.
## Package
```bash
$ npm run package
```
To package apps for all platforms:
```bash
$ npm run package-all
```
#### Options
- --name, -n: Application name (default: ElectronReact)
- --version, -v: Electron version (default: latest version)
- --asar, -a: [asar](https://github.com/atom/asar) support (default: false)
- --icon, -i: Application icon
- --all: pack for all platforms
Use `electron-packager` to pack your app with `--all` options for darwin (osx), linux and win32 (windows) platform. After build, you will find them in `release` folder. Otherwise, you will only find one for your os.
`test`, `tools`, `release` folder and devDependencies in `package.json` will be ignored by default.
#### Default Ignore modules
We add some module's `peerDependencies` to ignore option as default for application size reduction.
- `babel-core` is required by `babel-loader` and its size is ~19 MB
- `node-libs-browser` is required by `webpack` and its size is ~3MB.
> **Note:** If you want to use any above modules in runtime, for example: `require('babel/register')`, you should move them form `devDependencies` to `dependencies`.
#### Building windows apps from non-windows platforms
Please checkout [Building windows apps from non-windows platforms](https://github.com/maxogden/electron-packager#building-windows-apps-from-non-windows-platforms).
## Native-like UI
If you want to have native-like User Interface (OS X El Capitan and Windows 10), [react-desktop](https://github.com/gabrielbull/react-desktop) may perfect suit for you.
## License
MIT © [C. T. Lin](https://github.com/chentsulin)
[npm-image]: https://img.shields.io/npm/v/electron-react-boilerplate.svg?style=flat-square
[npm-url]: https://npmjs.org/package/electron-react-boilerplate
[travis-image]: https://travis-ci.org/chentsulin/electron-react-boilerplate.svg?branch=master
[travis-url]: https://travis-ci.org/chentsulin/electron-react-boilerplate
[david_img]: https://img.shields.io/david/chentsulin/electron-react-boilerplate.svg
[david_site]: https://david-dm.org/chentsulin/electron-react-boilerplate