TUM-Live 项目教程

TUM-Live 项目教程

gocast TUMs lecture streaming service. 项目地址: https://gitcode.com/gh_mirrors/go/gocast

1. 项目目录结构及介绍

TUM-Live 项目的目录结构如下：

TUM-Live/
├── api/
├── branding/
├── cmd/
│   └── tumlive/
├── dao/
├── docs/
├── mock_dao/
├── mock_tools/
├── model/
├── tools/
├── vod-service/
├── voice-service/
├── web/
├── worker/
├── .gitattributes
├── .gitignore
├── .golangci.yml
├── .pre-commit-config.yaml
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── SECURITY.md
├── config.yaml
├── docker-compose.yml
├── go.mod
├── go.sum
├── go.work
├── go.work.sum
├── init.sql
├── renovate.json
├── target_architecture.png
└── tumlive.example.service

目录介绍

• api/: 包含项目的API相关代码。
• branding/: 包含项目的品牌定制文件，如logo、favicon等。
• cmd/: 包含项目的启动文件，其中tumlive/目录下是主要的启动文件。
• dao/: 包含数据访问对象（DAO）的代码。
• docs/: 包含项目的文档文件。
• mock_dao/: 包含模拟数据访问对象的代码，用于测试。
• mock_tools/: 包含模拟工具的代码，用于测试。
• model/: 包含数据模型的代码。
• tools/: 包含项目的工具代码。
• vod-service/: 包含视频点播服务的代码。
• voice-service/: 包含语音服务的代码。
• web/: 包含前端代码。
• worker/: 包含后台任务的代码。
• .gitattributes: Git属性配置文件。
• .gitignore: Git忽略文件配置。
• .golangci.yml: GolangCI-Lint配置文件。
• .pre-commit-config.yaml: Pre-commit钩子配置文件。
• Dockerfile: Docker构建文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建文件。
• README.md: 项目介绍文件。
• SECURITY.md: 项目安全相关文档。
• config.yaml: 项目配置文件。
• docker-compose.yml: Docker Compose配置文件。
• go.mod: Go模块依赖文件。
• go.sum: Go模块依赖校验文件。
• go.work: Go工作区文件。
• go.work.sum: Go工作区校验文件。
• init.sql: 数据库初始化脚本。
• renovate.json: Renovate配置文件。
• target_architecture.png: 项目架构图。
• tumlive.example.service: 示例服务文件。

2. 项目启动文件介绍

项目的启动文件位于cmd/tumlive/目录下，主要文件为tumlive.go。该文件负责启动整个TUM-Live服务。

启动文件介绍

• cmd/tumlive/tumlive.go: 这是项目的入口文件，负责初始化配置、启动服务、加载数据库等操作。

3. 项目配置文件介绍

项目的配置文件为config.yaml，位于项目根目录下。该文件包含了项目的各种配置选项，如数据库连接、服务端口、日志级别等。

配置文件介绍

• config.yaml: 项目的主要配置文件，包含以下配置项：
  • database: 数据库连接配置。
  • server: 服务端口配置。
  • log: 日志级别配置。
  • branding: 品牌定制配置。
  • security: 安全相关配置。

通过修改config.yaml文件，可以调整项目的运行参数，以适应不同的环境和需求。

gocast TUMs lecture streaming service. 项目地址: https://gitcode.com/gh_mirrors/go/gocast