Skip to content

Commit ab2c1c9

Browse files
authored
Update README with route-codegen (#23)
Update README
1 parent 1a13b2b commit ab2c1c9

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ $ docker ps
4646

4747
#### Sharing commons
4848

49-
To keep things simple, we do not share common components/functions/settings via published npm packages. Instead, `/common` serves as the place where commons live. When changes happen in source folders, they would get copied into target folders. Settings can be found and extended [here](./common/watcher.js#13-20). To start, run the following:
49+
To keep things simple, we do not share common components/functions/settings via published npm packages. Instead, `/common` serves as the place where commons live. When changes happen in source folders, they would get copied into target folders. Settings can be found and extended [here](./common/watcher.js#L13-L20). To start, run the following:
5050

5151
```
52-
$ yarn ws common:watch
52+
$ bra ws common:watch
5353
```
5454

5555
#### Turn on the containers the first time
@@ -85,5 +85,17 @@ $ bra start
8585
$ bra vm-down
8686
```
8787

88+
### Routing
89+
90+
It is easy to make mistake when routing between multiple apps. Inner-app routing can be done with client-side routing while inter-app routing must be done with server-side routing. That is why we are using `route-codegen` manage routing between all apps.
91+
92+
The config can be found [here](./route-manager/route-codegen.yml). After making changes, run the following to generate route modules:
93+
94+
```
95+
bra ws routegen
96+
```
97+
98+
Read more about [route-codegen](https://github.com/eddeee888/route-codegen)
99+
88100
Made with ♥ by Eddy Nguyen
89101
https://eddy.works

0 commit comments

Comments
 (0)