You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-11
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,21 @@
1
1
# electron-typescript-react-tailwind-redux
2
2
3
-
> A secure, modular, and easy to use [Electron Forge](https://www.electronforge.io/) boilerplate featuring [Typescript](https://www.typescriptlang.org/), [React](https://reactjs.org/), [Webpack](https://webpack.js.org/), [TailwindCSS](https://tailwindcss.com/), [Redux](https://redux.js.org/) and [persistance](https://github.com/saucesteals/electron-persist-secure) (with [redux-persist](https://github.com/rt2zz/redux-persist) support)
4
-
3
+
> A secure, modular, and easy to use [Electron Forge](https://www.electronforge.io/) boilerplate featuring [Typescript](https://www.typescriptlang.org/), [React](https://reactjs.org/), [Webpack](https://webpack.js.org/), [TailwindCSS](https://tailwindcss.com/), [Redux](https://redux.js.org/) and [persistance](https://github.com/saucesteals/electron-persist-secure) (with [redux-persist](https://github.com/rt2zz/redux-persist) support)
5
4
6
5
---
7
6
8
7
### **Installation**
9
8
10
9
Clone the repository locally with **none** of its git history
Generate a GitHub repository with the [Use this template](https://github.com/saucesteals/electron-typescript-react-tailwind-redux/generate) button above
@@ -27,21 +28,24 @@ $ cd your-project-name
27
28
$ yarn
28
29
```
29
30
30
-
31
31
---
32
32
33
33
### **Starting Development**
34
34
35
35
Start the app in the `dev` environment:
36
+
36
37
```sh
37
38
yarn start
38
39
```
39
40
40
41
---
41
42
42
43
### **Packaging for Production**
44
+
43
45
To package apps into a local executable:
46
+
44
47
- Personalize the forge **maker** configs at `/.config/forge.config.js`
48
+
45
49
```sh
46
50
yarn make:win
47
51
# yarn make:mac
@@ -51,9 +55,11 @@ yarn make:win
51
55
---
52
56
53
57
### **Releasing with GitHub**
58
+
54
59
1. Copy the contents of `env.example` to `.env` (Copy into a blank one if you dont already have one)
55
-
2. Set your `GH_TOKEN`
60
+
2. Set your `GH_TOKEN`
56
61
3. Personalize the forge **publisher** configs at `/.config/forge.config.js`
62
+
57
63
```sh
58
64
yarn publish:win
59
65
# yarn publish:mac
@@ -66,9 +72,11 @@ yarn publish:win
66
72
67
73
1. Ensure that you have a high quality `source.png` icon in your `/assets/package` folder
68
74
2. Run:
75
+
69
76
```sh
70
77
yarn create-icons
71
78
```
79
+
72
80
3. Check your new icons in `/assets/package/icons`
73
81
74
82
---
@@ -100,12 +108,12 @@ yarn create-icons
100
108
101
109
... # add on bridges in other files or include them in index.ts
102
110
# make sure to import any new bridge files in the preload
103
-
111
+
104
112
- /app # backend code
105
113
- /ipc # ipcRenderer -> ipcMain listeners
106
114
- main.ts # main functionality ipc listeners
107
115
# ex. quit/hide
108
-
116
+
109
117
... # add on as u go
110
118
# make sure to add imports to new ipc files
111
119
# in the main electron entry
@@ -120,10 +128,10 @@ yarn create-icons
120
128
121
129
- Routes.tsx # react-router routes
122
130
123
-
- App.tsx # Export entire app with routes components
131
+
- App.tsx # Export entire app with routes components
124
132
# and redux provider if you are using it
125
133
126
-
-
134
+
-
127
135
128
136
main.ts # main "backend" electron entry
129
137
@@ -136,6 +144,7 @@ yarn create-icons
136
144
---
137
145
138
146
### **Contributing**
147
+
139
148
When contributing to this repository, please first discuss the change you wish to make via an issue.
140
149
141
150
1. Fork the Project
@@ -144,9 +153,9 @@ When contributing to this repository, please first discuss the change you wish t
144
153
4. Push to the Branch (**git push origin feature/AmazingFeature**)
0 commit comments