TSRPC 示例项目教程

1. 项目的目录结构及介绍

TSRPC 示例项目的目录结构如下：

tsrpc-examples/
├── examples/
│   ├── first-api/
│   │   ├── backend/
│   │   └── frontend/
│   └── ...
├── scripts/
├── .gitignore
├── LICENSE
└── README.md

目录结构介绍

• examples/: 包含多个示例项目，每个示例项目通常包含 backend 和 frontend 两个子目录，分别用于存放后端和前端代码。
• scripts/: 包含项目所需的脚本文件。
• .gitignore: Git 忽略文件，定义了哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档，通常包含项目的简介、安装和使用说明等。

2. 项目的启动文件介绍

在每个示例项目的 backend 和 frontend 目录中，通常会有一个启动文件用于启动项目。

后端启动文件

在 backend 目录中，通常会有一个 index.ts 或 server.ts 文件，用于启动后端服务。例如：

// backend/index.ts
import { initServer } from 'tsrpc';

const server = initServer();
server.listen(3000);

前端启动文件

在 frontend 目录中，通常会有一个 index.ts 或 app.ts 文件，用于启动前端服务。例如：

// frontend/index.ts
import { initClient } from 'tsrpc';

const client = initClient();
client.connect('http://localhost:3000');

3. 项目的配置文件介绍

TSRPC 示例项目中常见的配置文件包括 tsconfig.json 和 package.json。

tsconfig.json

tsconfig.json 文件用于配置 TypeScript 编译器选项。例如：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules"]
}

package.json

package.json 文件用于定义项目的元数据和依赖项。例如：

{
  "name": "tsrpc-examples",
  "version": "1.0.0",
  "description": "TSRPC 示例项目",
  "main": "index.js",
  "scripts": {
    "dev": "ts-node src/index.ts",
    "build": "tsc",
    "start": "node dist/index.js"
  },
  "dependencies": {
    "tsrpc": "^3.0.0"
  },
  "devDependencies": {
    "ts-node": "^10.0.0",
    "typescript": "^4.0.0"
  }
}

通过以上配置文件，可以方便地管理项目的依赖和编译选项，确保项目能够顺利启动和运行。