TSRPC_Badminton-Scoreboard/backend/README.md

31 lines
392 B
Markdown
Raw Permalink Normal View History

2022-04-29 06:54:55 +00:00
# TSRPC Server
## Usage
### Local dev server
Dev server would restart automatically when code changed.
```
npm run dev
```
### Build
```
npm run build
```
### Generate API document
Generate API document in swagger/openapi and markdown format.
```shell
npm run doc
```
2022-05-04 03:13:09 +00:00
### Run unit Test
Execute `npm run dev` first, then execute:
2022-04-29 06:54:55 +00:00
```
2022-05-04 03:13:09 +00:00
npm run test
2022-04-29 06:54:55 +00:00
```
2022-05-04 03:13:09 +00:00
---