Skip to content

Commit 5ab4b2f

Browse files
committed
update README
1 parent d12d7e5 commit 5ab4b2f

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To copy the template in an empty local folder without creating of a repo or in a
1010
npx degit Kallenju/template-for-react-ts-ssr-hmr
1111
```
1212

13-
Install packages and run development servers:
13+
The `./dist/` folder is the root of the site. It is created by Webpack and contains the result of the build process. To start the development servers, run the following command:
1414

1515
```shell
1616
npm install
@@ -20,6 +20,25 @@ npm run dev
2020

2121
## Structure of the template
2222

23+
### Structure of the root folder (`./`)
24+
25+
- **\_\_tests\_\_**
26+
- **bin**
27+
- **config**
28+
- **dist**
29+
- **src**
30+
31+
### Structure of the dist folder (`./dist`)
32+
33+
- **client**
34+
- **fonts**
35+
- **images**
36+
- **styles**
37+
- **server**
38+
- **shared**
39+
- **Header**
40+
- **Layout**
41+
2342
### Structure of the source folder (`./src`)
2443

2544
- **assets**
@@ -40,12 +59,6 @@ npm run dev
4059

4160
## How it works
4261

43-
The `./dist/` folder is the root of the site. It is created by Webpack and contains the result of the build process:
44-
45-
```shell
46-
npm run dev
47-
```
48-
4962
### Server-Side Rendering
5063

5164
`./src` contains `App.tsx`, which is the entry point of the React app. It imports components from `./src/shared` and global styles from `./assets/styles/`. `App.tsx` is in turn imported by server (`server.tsx`) and client (`index.tsx`) files in `./src/server/` and `./src/client/`, respectively.

0 commit comments

Comments
 (0)