Skip to content

Commit 720690c

Browse files
committed
readme.md content updated
1 parent b6814f5 commit 720690c

File tree

1 file changed

+17
-29
lines changed

1 file changed

+17
-29
lines changed

README.md

Lines changed: 17 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,26 @@
11

2-
# Express-React-Scaffold [![Build Status](https://travis-ci.org/arpitgo4/Express-React-Scaffold.svg?branch=master)](https://travis-ci.org/arpitgo4/Express-React-Scaffold) [![Coverage Status](https://coveralls.io/repos/github/arpitgo4/Express-React-Scaffold/badge.svg?branch=master)](https://coveralls.io/github/arpitgo4/Express-React-Scaffold?branch=master)
2+
# React-Redux-Scaffold [![Build Status](https://travis-ci.org/arpitgo4/Express-React-Scaffold.svg?branch=master)](https://travis-ci.org/arpitgo4/Express-React-Scaffold) [![Coverage Status](https://coveralls.io/repos/github/arpitgo4/Express-React-Scaffold/badge.svg?branch=master)](https://coveralls.io/github/arpitgo4/Express-React-Scaffold?branch=master)
33
Full stack JS scaffold with ExpressJS as the backend server and React-Redux on the client side. Scaffold supports production and development modes, with **Best Developer Experience** ( DX ) by Hot-Loading for the client side application and automatic server restarts for the backend server on code change. There will be no need to restart during development, hence making the experience smooth and decrease the delivery time.
44

55
## Scaffold Structure
66

77
```
88
.
9-
├── bin # Backend server ( Express )
10-
| └── www # Express server configuration ( port, address, clustering )
11-
├── client # Frontend complete source code
12-
| ├── src # Frontend source files
13-
| | ├── components # React component's source
14-
| | ├── config # Redux store's configuration
15-
| | ├── layouts # React layout component's source
16-
| | | └── router.js # React Router
17-
| | ├── reducers # Redux reducer's source
18-
| | ├── index.html # Root HTML template
19-
| | ├── index.js # Frontend source entry point
20-
| | └── style.css # Global stylesheet
21-
| ├── .babelrc # Babel configuration ( ES6, React, JSX )
22-
| ├── .eslintrc # ESLint configuration
23-
| └── devServer.js # Hot loading server source ( development mode )
9+
├── src # Frontend source files
10+
| ├── components # React component's source
11+
| ├── config # Redux store's configuration
12+
| ├── layouts # React layout component's source
13+
| | └── App.Router.js # React Router
14+
| ├── reducers # Redux reducer's source
15+
| ├── index.html # Root HTML template
16+
| ├── index.js # Frontend source entry point
17+
| └── style.css # Global stylesheet
18+
├── .babelrc # Babel configuration ( ES6, React, JSX )
19+
├── .eslintrc # ESLint configuration
20+
├── devServer.js # Hot loading server source ( development mode )
2421
├── dist # Compiled files
25-
├── routes # Route files
26-
| └── index.js # REST/HTTP endpoints
2722
├── .gitignore # Ignored files from git commit
28-
├── app.js # Express server configuration ( routes, middlewares, models )
23+
├── server.js # Express server configuration ( routes, middlewares, models )
2924
├── LICENSE # License to use the project
3025
├── package.json # Frontend and backend dependencies
3126
├── README.md # This file
@@ -40,7 +35,7 @@ Full stack JS scaffold with ExpressJS as the backend server and React-Redux on t
4035
npm install
4136
4237
# Build the client
43-
npm run build-client:production
38+
npm run build:production
4439
4540
# Start the project ( it will build the client, before starting the server )
4641
npm start
@@ -53,25 +48,18 @@ npm start
5348
### Scaffold provides two npm scripts, execute both in seperate terminals
5449
```
5550
# Start client in development mode with hot code loading,
56-
npm run start-client:development
57-
58-
# Start backend server in development mode with nodemon ( server restarts on every change )
59-
npm run start-server:development
51+
npm run start:development
6052
```
6153

6254
Frontend and Backend dev servers will start at http://localhost:3000 and http://localhost:8080, respectively.
6355
Hit frontend dev server to load application in the browser, enjoy developing :)
6456

65-
### Proxy Middleware
66-
Client's development process will proxy all the API requests with `'/api'` in the URL to the backend server. `devServer.js` is in the `client/src` directory starts server at http://localhost:3000, which will provide all the hot loading functionality and proxy the API calls to the backend server process behind the scenes.
67-
React-Hot-Loader is used to hot load the components without losing the current state or refreshing the browser. Redux store maintains all the state of the application in the single state object.
68-
6957
Refer to the [react-hot-boilerplate](https://github.com/gaearon/react-hot-boilerplate) for further description.
7058
## Production
7159
### Scaffold provides two production scripts
7260
```
7361
# Build the client for production deployment
74-
npm run build-client:production
62+
npm run build:production
7563
7664
# Build the client for production deployment and start the backend server with 'forever' package
7765
npm start

0 commit comments

Comments
 (0)