Skip to content

Commit a0fb9e1

Browse files
committed
update README.md
1 parent 563da03 commit a0fb9e1

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

packages/create-react-scripts-ssr/README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,27 @@ The server will auto reload if code changes.
1818
By default, **webpack-dev-server is running on port: 3001** while the **server is running on 3000**.
1919
The following environment variables are injected to `server side bundling`
2020

21-
`HOST`: The host that the server should be running on.
22-
`PORT`: The port number that the server should be running on.
23-
`PROTOCOL`: The protocol that the server should be running on.
24-
`PUBLIC_URL`: The absolute url that the webpack-dev-server is running.
21+
`HOST`: The host that the server should be running on.
22+
`PORT`: The port number that the server should be running on.
23+
`PROTOCOL`: The protocol that the server should be running on.
24+
`PUBLIC_URL`: The absolute url that the webpack-dev-server is running.
2525

2626
**All client side log would be supressed in the console.**
27-
The client build is located in `build/client`
28-
The server build is located in `build/server`
29-
An assets json manifest is located in `build/assets.json`, which is useful for server-side-rendering.
30-
This script will start the `webpack-dev-server` and the `server.js`
27+
The client build is located in `build/client`
28+
The server build is located in `build/server`
29+
An assets json manifest is located in `build/assets.json`, which is useful for server-side-rendering.
30+
If autodll plugin is detected, an assets json manifest is located in `build/dll-assets.json`, which is useful for server-side-rendering.
31+
This script will start the `webpack-dev-server` and the `server.js`
3132

3233
### build:server
33-
trigger both `client side` and `server side` webpack tasks build.
34-
An assets json manifest is located in `build/assets.json`, which is useful for server-side-rendering.
35-
You can start the server by `node build/server` after build.
34+
trigger both `client side` and `server side` webpack tasks build.
35+
An assets json manifest is located in `build/assets.json`, which is useful for server-side-rendering.
36+
You can start the server by `node build/server` after build.
3637

3738
# How it works?
3839
----------------
39-
Webpack bundle both different environment, the client side and the server side.
40-
Make use of [assets-webpack-plugin](https://github.com/kossnocorp/assets-webpack-plugin) to produce assets mapping so that server side can know the filename produced in client side build.
40+
Webpack bundle both different environment, the client side and the server side.
41+
Make use of [assets-webpack-plugin](https://github.com/kossnocorp/assets-webpack-plugin) to produce assets mapping so that server side can know the filename produced in client side build.
4142

4243
# Usage
4344
---------------
@@ -164,4 +165,4 @@ This step is to make the source mapping correct in the stack trace if error is t
164165
`npm run build:server` or `yarn build:server`
165166

166167
# Working Example
167-
[raymondsze/example-universal-react-app](https://github.com/raymondsze/create-react-scripts/packages/example-universal-react-app)
168+
[raymondsze/example-universal-react-app](https://github.com/raymondsze/create-react-scripts/tree/master/packages/example-universal-react-app)

0 commit comments

Comments
 (0)