Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tahnik/electron-react
A simple and compact boilerplate for electron and react (redux, router)
https://github.com/tahnik/electron-react
babel boilerplate electron eslint react react-router-v4 redux webpack3
Last synced: 25 days ago
JSON representation
A simple and compact boilerplate for electron and react (redux, router)
- Host: GitHub
- URL: https://github.com/tahnik/electron-react
- Owner: tahnik
- License: mit
- Created: 2017-03-08T23:48:46.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-02T07:21:17.000Z (over 6 years ago)
- Last Synced: 2024-09-28T22:08:11.818Z (about 1 month ago)
- Topics: babel, boilerplate, electron, eslint, react, react-router-v4, redux, webpack3
- Language: JavaScript
- Homepage:
- Size: 1.35 MB
- Stars: 66
- Watchers: 6
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ElectronJS + ReactJS boilerplate
A simple and clean boilerplate for Electron and react. It includes:
- State management with [Redux]
- Routing with [React-Router v4]
- [React] and [Redux devtools] for debugging
- .eslint for [ESlint]
- [Webpack 3] for bundling
- [Babel] for compiling
## Usage
NodeJS v8.3.0
- Clone the repo
`git clone https://github.com/tahnik/electron-react.git`
- Edit the package.json to change the `name` to your project name and `description` to your project description. Change the `author` as well.
- Run `npm i`
- Then run the project as described in the section below
## How to
- To run in development mode with hot reloading, open a terminal inside your project and run
```bash
npm run dev
```
This commands creates a webpack dev server which will watch and reload the bundle as you edit and will it available at https://localhost:8080.
The command will also run the electron app in development mode. So it will open up devtools with React and Redux devtools initialized.
- To build the app and test if it is working:
```bash
npm start
```
This command will compile the app in production mode and start the app. Here is you still toggle the developer tools from the menu and see if there is any errors
- To package the app and create a distributable:
```bash
npm run dist
```
This will create a relevant distributable file. For example, if you are on Windows, it will create a .exe file in the release folder.
# Contribute
Awesome! Create a new issue or do a pull request.
[Redux]:
[React-Router v4]:
[React]:
[Redux devtools]:
[Jest]:
[ESlint]:
[Webpack 3]:
[Babel]:
[Yeoman]: