TimeSide 技术文档

1. 安装指南

TimeSide 提供了基于 Docker 的快速安装方式。首先，您需要在系统中安装 Docker 和 docker compose。

• 安装 Docker：请访问 Docker 官方文档获取安装指南，地址为 Docker 官方文档。
• 安装 docker compose：请访问 Docker 官方文档获取安装指南，地址为 docker compose 官方文档。

安装完 Docker 和 docker compose 后，执行以下命令克隆 TimeSide 仓库并启动服务：

git clone --recursive https://github.com/Ircam-WAM/TimeSide.git
cd TimeSide
docker compose up -d

2. 项目的使用说明

TimeSide 项目主要包括三个部分：核心模块（Core）、Web 服务器和 RESTful API、JavaScript SDK。

• 核心模块：提供 Python 库，可在命令行或任何基于 Python 的程序中工作。
• Web 服务器和 RESTful API：构建在核心模块之上，允许 Web 开发人员轻松将远程处理服务嵌入到自己的应用程序中。
• JavaScript SDK：基于 OpenAPI，便于开发第三方应用程序，使用服务器的 API。

具体使用方法请参考官方文档：TimeSide 完整文档。

3. 项目API使用文档

TimeSide 提供了丰富的 RESTful API，具体使用方法请参考官方文档：TimeSide REST API 文档。

4. 项目安装方式

除了基于 Docker 的安装方式，TimeSide 还支持在非 Docker 环境下的安装。如果您需要在非 Docker 环境下使用 TimeSide，请参考 Dockerfile 中的规则，该规则基于 Debian 稳定系统。但请注意，我们不会为在 Docker 容器之外的使用提供免费支持。

以上就是 TimeSide 项目的安装指南、使用说明和 API 使用文档。如果您在使用过程中遇到任何问题，请与开发团队联系以获取技术支持。