API-200 自托管版本使用教程

1. 项目目录结构及介绍

API-200的自托管版本包含以下目录和文件：

• assets/: 存放静态资源，如图片、样式表等。
• packages/: 可能包含项目依赖的第三方库。
• volumes/: 存储容器数据卷。
• .gitignore: 指定Git应该忽略的文件和目录。
• LICENCE.md: 项目许可证信息。
• README.md: 项目说明文件。
• docker-compose.yml: 定义服务、网络和卷的Docker Compose配置文件。
• package-lock.json: 包含项目的依赖项的精确版本。
• package.json: 定义项目的元数据和脚本。
• pnpm-lock.yaml: PNPM包管理器的锁定文件。
• setup.js: 项目初始化脚本。
• 其他可能存在的脚本和配置文件。

每个目录和文件的作用在上文中都有简要说明，提供了项目的基本结构和配置。

2. 项目的启动文件介绍

项目的启动主要通过以下文件进行：

• docker-compose.yml: 此文件用于启动Docker容器，定义了项目所需的服务，如数据库、缓存和API服务。使用以下命令启动服务：

  docker-compose up -d
  

• setup.js: 此脚本用于初始化项目环境，可能包括创建数据库结构、设置环境变量等。根据是否在本地主机上运行，可以使用以下命令运行此脚本：

  • 本地主机（建议使用管理员权限）：

    sudo node setup.js
    

  • 非本地主机：

    node setup.js
    

3. 项目的配置文件介绍

项目的配置主要通过以下文件进行：

• docker-compose.yml: 在这个文件中，你可以配置服务的环境变量、卷、网络等。例如，如果你需要修改数据库的连接字符串，你可以在相应的服务部分添加或修改环境变量。

• package.json: 此文件中可能包含了项目的一些脚本和命令，例如启动开发服务器或构建生产版本的命令。你可以通过编辑这个文件来添加自定义的启动脚本。

• 可能存在的其他配置文件，如.env文件，用于设置环境变量，这些变量在应用启动时会被加载。

确保在修改任何配置文件后，重新启动服务以使更改生效。