|
1 | | -# **Electron-React-TypeScript-Base** |
| 1 | +# **Electron-React-TypeScript-Webpack-Boilerplate** |
2 | 2 |
|
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). |
7 | 8 |
|
8 | 9 | ## **How Does It Work?** |
9 | 10 | ``` |
10 | 11 | // execute |
11 | 12 | git clone https://github.com/iamWing/electron-react-typescript-base-proj.git |
| 13 | +``` |
12 | 14 |
|
| 15 | +``` |
13 | 16 | // edit the following fields in package.json for your own project |
14 | 17 | { |
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} |
24 | 32 | } |
25 | 33 | ``` |
26 | 34 |
|
27 | | -## **Folder structure:** |
| 35 | +Then execute `npm run dev` to start develop your app. |
| 36 | + |
| 37 | +## **Folder structure** |
28 | 38 | ``` |
29 | 39 | 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 |
34 | 41 | | - node_modules/ |
| 42 | +| - out/ //- Generated by build script automatically |
35 | 43 | | - public/ //- Global static assets |
36 | 44 | | | - index.html |
37 | 45 | | | - style.css |
38 | 46 | | - src/ |
39 | | -| | - actions/ //- Redux actions |
40 | 47 | | | - main/ //- Electron / backend modules |
41 | 48 | | | | - main.ts //- Entry point of 'electron-main' |
42 | 49 | | | - models/ |
43 | | -| | - reducers/ //- Redux reducers |
44 | 50 | | | - renderer/ //- React / frontend components |
45 | | -| | | - components/ |
46 | | -| | | - containers/ |
47 | 51 | | | | - renderer.tsx //- Entry point of 'electron-renderer' |
48 | 52 | | | - utils/ //- Common utilities |
49 | | -| | - declarations.d.ts |
50 | 53 | | - test/ //- Unit tests |
51 | 54 | | - .gitignore |
52 | 55 | | - package-lock.json |
53 | 56 | | - package.json |
54 | 57 | | - tsconfig.json //- TypeScript config |
55 | 58 | | - 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 |
59 | 60 | ``` |
60 | 61 |
|
61 | 62 | ## **License** |
62 | 63 |
|
63 | | -MIT |
| 64 | +Electron React TypeScript Webpack Boilerplate is open source software |
| 65 | +[licensed as MIT](LICENSE). |
0 commit comments