Skip to content

Commit 0e355bd

Browse files
Create README.md
1 parent 98a599c commit 0e355bd

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# React Electron App
2+
Create React Electron App Ready Configured For Production Build
3+
4+
This package creates **React+Electron App** using the famous [create-react-app](https://github.com/facebook/create-react-app#readme)
5+
library and following the additional steps taken from [this blog](https://medium.com/@kitze/%EF%B8%8F-from-react-to-an-electron-app-ready-for-production-a0468ecb1da3)
6+
7+
8+
9+
## Install
10+
To Install The Package Simply Run:
11+
```bash
12+
npm install react-electron-app -g
13+
```
14+
15+
## Usage
16+
17+
After installing the package simply run
18+
19+
```bash
20+
react-electron-app new <appname>
21+
```
22+
23+
## Running the Project
24+
25+
to start the electron browser in development mode simply type
26+
27+
```bash
28+
npm run electron-dev
29+
```
30+
31+
to pack the electron app simply type
32+
33+
```bash
34+
npm run electron-pack
35+
```
36+
37+
by default this package will build the app for Mac OS, Linux and Windows. You can specify one of them by editing the `package.json`
38+
file
39+
40+
```json
41+
"electron-pack": "build -c.extraMetadata.main=build/electron.js -mlw",
42+
```
43+
change the `-mlw` to the OS's you want to build the electron app for.
44+
* -m : Mac OS
45+
* -l : Linux
46+
* -w : Windows
47+
48+
The packaged app will be generated in the `dist/` directory.
49+
50+
### Be Amazing ..

0 commit comments

Comments
 (0)