Skip to content

Commit c8fb88c

Browse files
committed
Update README
1 parent a6ad8cd commit c8fb88c

File tree

1 file changed

+30
-28
lines changed

1 file changed

+30
-28
lines changed

README.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,65 @@
1-
# **Electron-React-TypeScript-Base**
1+
# **Electron-React-TypeScript-Webpack-Boilerplate**
22

3-
This is a pre-configured Electron.js + React.js + TypeScript project with
4-
webpack v4 & TSLint config provided. `react-router` & `react-redux` is listed
5-
in dependencies section of `package.json`, and the folder structure is redux
6-
ready.
3+
Pre-configured Electron.js + React.js + TypeScript boilerplate with
4+
Webpack v4 & linters config predefined.
5+
6+
This boilerplate works on Mac, Windows, and Linux.
7+
If something doesn't work, please [file and issue](https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/issues/new).
78

89
## **How Does It Work?**
910
```
1011
// execute
1112
git clone https://github.com/iamWing/electron-react-typescript-base-proj.git
13+
```
1214

15+
```
1316
// edit the following fields in package.json for your own project
1417
{
15-
"name": {your-project-name},
16-
"version": {what-ever-you-like},
17-
"description": {your-own-description},
18-
"author": {who's-the-author?},
19-
"license": {if-you-don't-want-to-use-MIT}
20-
"repository": {type-and-link-of-your-repo},
21-
"keywords": {keywords-of-your-project},
22-
"bugs": {issue-page-of-your-repo},
23-
"homepage": {homepage-of-your-repo}
18+
"name": {your-project-name},
19+
"version": {whatever-you-like},
20+
"description": {your-own-description},
21+
"build": {
22+
"appId": {your-app-id},
23+
"productName": {your-product-name},
24+
"buildVersion": {whatever-you-like}
25+
}
26+
"author": {who's-the-author?},
27+
"license": {if-you-don't-want-to-use-MIT}
28+
"repository": {type-and-link-of-your-repo},
29+
"keywords": {keywords-of-your-project},
30+
"bugs": {issue-page-of-your-repo},
31+
"homepage": {homepage-of-your-repo}
2432
}
2533
```
2634

27-
## **Folder structure:**
35+
Then execute `npm run dev` to start develop your app.
36+
37+
## **Folder structure**
2838
```
2939
electron-react-typescript-base-proj/
30-
| - dist/ //- Generated by webpack automatically
31-
| | - index.html
32-
| | - main.bundle.js
33-
| | - renderer.bundle.js
40+
| - dist/ //- Generated by Webpack automatically
3441
| - node_modules/
42+
| - out/ //- Generated by build script automatically
3543
| - public/ //- Global static assets
3644
| | - index.html
3745
| | - style.css
3846
| - src/
39-
| | - actions/ //- Redux actions
4047
| | - main/ //- Electron / backend modules
4148
| | | - main.ts //- Entry point of 'electron-main'
4249
| | - models/
43-
| | - reducers/ //- Redux reducers
4450
| | - renderer/ //- React / frontend components
45-
| | | - components/
46-
| | | - containers/
4751
| | | - renderer.tsx //- Entry point of 'electron-renderer'
4852
| | - utils/ //- Common utilities
49-
| | - declarations.d.ts
5053
| - test/ //- Unit tests
5154
| - .gitignore
5255
| - package-lock.json
5356
| - package.json
5457
| - tsconfig.json //- TypeScript config
5558
| - tslint.json //- TSLint config
56-
| - webpack.common.js //- webpack base config
57-
| - webpack.dev.js //- webpack development config
58-
| - webpack.prod.js //- webpack production config
59+
| - webpack.config.js //- Webpack config
5960
```
6061

6162
## **License**
6263

63-
MIT
64+
Electron React TypeScript Webpack Boilerplate is open source software
65+
[licensed as MIT](LICENSE).

0 commit comments

Comments
 (0)