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
+23-19Lines changed: 23 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ The PRD really sttarted kit for **ReactJs** with hot module replacement (HMR) fo
33
33
34
34
Based on the best practises of the Single-Page-Application development with NodeJS. I added the nice font-end component [Material-Dashboard-React](https://github.com/creativetimofficial/material-dashboard-react) and Redux store integration.
35
35
36
-
Beside of that I also developped some useful compoment as Message box, Notification to make the Started-kit to be a **Production ready** SPA.
36
+
Beside of that I also developped some useful compoment as Message box, Notification to make the Started-kit to be a **Production ready** SPA kit.
37
37
38
38
## Support Features
39
39
@@ -61,15 +61,13 @@ async function getDataFromServer() {
61
61
}
62
62
```
63
63
64
-
###Installation
64
+
## Installation
65
65
66
66
1. Clone/download repo
67
67
2.`npm install`
68
68
3. Replace the CodeCov.io token to your one in the `package.json` file.
69
69
4. Run `npm start` to run the project.
70
70
71
-
---
72
-
73
71
## Usage
74
72
75
73
### Development
@@ -92,12 +90,12 @@ async function getDataFromServer() {
92
90
93
91
- Analysis served @ `http://localhost:8888`
94
92
95
-
---
96
-
97
93
## New Compoments
98
94
99
95
1.**Message Box and Notification**: Allow to show Info, Confirm, Success and Error message and notification. Refer to the MessageBox in Views folder so sample that using Redux store to manage the state.
100
96
97
+
## Environment Supports
98
+
101
99
### Docker Support
102
100
103
101
1. Build Image `docker build`.
@@ -106,36 +104,42 @@ async function getDataFromServer() {
106
104
3. Push inage to Docker hub `docker push [YOUR_ID]/react-materialui-started-kit:latest`
107
105
Example `docker push baoduy2412/react-materialui-started-kit:latest`.
108
106
109
-
The application will running port 3000 in Docker.
107
+
The application will running port 80 and 443 in Docker.
110
108
The image can be found in Docker hub [here](https://hub.docker.com/r/baoduy2412/react-materialui-started-kit/).
111
109
112
-
**If you are using Docker the `Docker` folder in this project can be deleted without any impact.**
113
-
114
-
---
110
+
However if you are not using Docker just simply remove the submodule **sm-react-docker-nginx** There is no impact to the application.
115
111
116
112
### IIS Support
117
113
118
-
The `Web.config` file had been added for IIS hosting purpose. When build the application this file will be copied to dist folder automatically and make the package ready for IIS.
114
+
The `Web.config` file in **sm-react-iis**had been added for IIS hosting purpose. This file should be copy along with all files in dist folder when hosting in IIS.
119
115
120
-
However if you are not hosting this app in IIS just simply delete this file.or leave if there. There is no impact to the application.
116
+
However if you are not hosting this app in IIS just simply remove the submodule **sm-react-iis** There is no impact to the application.
121
117
122
118
### Azure Service Fabric Support
123
119
124
-
All stuffs in `service-fabric` folder are using for **[Azure Service Fabric](https://azure.microsoft.com/en-us/services/service-fabric/)** hosting purpose.
125
-
The project inside this folder will copy all files in dist folder and host as a static side in Azure Service Fabric.
126
-
I'm using .Net Core 2.0 to make the project is flexible enough to host on any platforms.
120
+
All stuffs in `sm-react-service-fabric` folder are using for **[Azure Service Fabric](https://azure.microsoft.com/en-us/services/service-fabric/)** hosting purpose.
121
+
122
+
The C# project inside this folder will copy all files from dist folder to wwwroot folder and host them as a static side in Azure Service Fabric.
123
+
124
+
Currently, I'm using .Net Core 2.1 to make the project is flexible enough to host on any platforms.
127
125
128
126
When build the Service Fabric application it will copy all files in `dist` folder to `wwwroot` folder. So ensure you run the `npm build` before deploy the Service Fabric app.
129
127
130
-
Defiantly, If you are not using **Azure Service Fabric**. This folder shall be deleted.
128
+
However if you are not using Service Fabric just simply remove the submodule **sm-react-service-fabric** There is no impact to the application.
129
+
130
+
### Node Js Hosting
131
+
132
+
There is a sub module contains the Express.js configuration to host the application in the Node Js environment.
133
+
The application will running port 3000 and 3001 in NodeJs and the port is configurable in the Js file.
134
+
135
+
If you are not using Node Js hosting just simply remove the submodule **sm-react-node-express** There is no impact to the application.
136
+
But, please note that the `npm run start-prod` is using this submodule to hosting the dist folder as a static side. Please be considered before removing this module.
131
137
132
138
### GZIP and SSL
133
139
134
140
The **GZIP** and **SSL** had been applied for all hosting environments above.
0 commit comments