Mercury 项目使用教程

1. 项目目录结构及介绍

Mercury 项目的目录结构如下：

mercury/
├── docker/
├── frontend/
├── mercury/
├── scripts/
├── .gitattributes
├── .gitignore
├── COMMERCIAL-LICENSE.txt
├── CONTRIBUTOR_LICENSE_AGREEMENT.md
├── LICENSE.txt
├── MANIFEST.in
├── README.md
├── docker-compose-https.yml
├── docker-compose.yml
├── pyproject.toml
├── setup-https.sh
└── setup.py

目录介绍

• docker/: 包含与 Docker 相关的文件和配置。
• frontend/: 前端代码和资源文件。
• mercury/: 项目的主要代码库，包含核心功能和逻辑。
• scripts/: 包含一些辅助脚本，用于项目的构建和部署。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• COMMERCIAL-LICENSE.txt: 商业许可证文件。
• CONTRIBUTOR_LICENSE_AGREEMENT.md: 贡献者许可协议。
• LICENSE.txt: 项目许可证文件。
• MANIFEST.in: Python 包清单文件。
• README.md: 项目介绍和使用说明。
• docker-compose-https.yml: 用于 HTTPS 的 Docker Compose 配置文件。
• docker-compose.yml: Docker Compose 配置文件。
• pyproject.toml: Python 项目配置文件。
• setup-https.sh: 用于 HTTPS 的设置脚本。
• setup.py: Python 项目安装脚本。

2. 项目启动文件介绍

Mercury 项目的启动文件主要是 setup.py 和 docker-compose.yml。

setup.py

setup.py 是 Python 项目的标准安装脚本。它包含了项目的元数据和依赖项，可以通过以下命令来安装项目：

pip install .

docker-compose.yml

docker-compose.yml 是用于定义和运行多容器 Docker 应用程序的配置文件。通过以下命令可以启动项目：

docker-compose up

3. 项目配置文件介绍

Mercury 项目的配置文件主要包括 pyproject.toml 和 docker-compose.yml。

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，用于定义项目的构建系统和依赖项。它包含了项目的版本、作者、依赖库等信息。

docker-compose.yml

docker-compose.yml 是 Docker Compose 的配置文件，用于定义多个 Docker 容器的配置和依赖关系。它包含了服务的定义、网络配置、卷挂载等信息。

通过这些配置文件，可以方便地管理和部署 Mercury 项目。