Qmedia 开源项目安装与使用教程

Qmedia 开源项目安装与使用教程

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

Qmedia 项目的目录结构如下：

Qmedia/
├── assets/
│   └── medias/
├── docs/
│   └── images/
├── mm_server/
├── mmrag_server/
├── qmedia_web/
├── test/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── README.zh-CN.md
└── docker-compose.yml

目录结构介绍

• assets/: 包含多媒体文件和伪数据文件。
  • medias/: 存放图像和视频文件。
• docs/: 项目文档文件夹，包含图片等资源。
  • images/: 存放文档中的图片资源。
• mm_server/: 多模态模型服务，负责模型的部署和API调用。
• mmrag_server/: 内容搜索和问答服务，负责内容卡片展示和查询。
• qmedia_web/: Web 服务，使用 TypeScript、Next.js、Tailwind CSS 和 Shadcn/UI 技术栈。
• test/: 测试文件夹，包含项目的测试代码。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• README.zh-CN.md: 中文项目介绍和使用说明。
• docker-compose.yml: Docker 配置文件，用于容器化部署。

2. 项目的启动文件介绍

mm_server 启动文件

cd mm_server
source activate qllm
python main.py

mmrag_server 启动文件

cd mmrag_server
source activate qmedia
python main.py

qmedia_web 启动文件

cd qmedia_web
pnpm dev

3. 项目的配置文件介绍

docker-compose.yml

docker-compose.yml 文件用于定义和运行多个 Docker 容器的配置。以下是一个简化的示例：

version: '3.8'
services:
  mm_server:
    image: qmedia/mm_server
    ports:
      - "50110:50110"
    volumes:
      - ./mm_server:/app
    environment:
      - ENV_VAR=value

  mmrag_server:
    image: qmedia/mmrag_server
    ports:
      - "50111:50111"
    volumes:
      - ./mmrag_server:/app
    environment:
      - ENV_VAR=value

  qmedia_web:
    image: qmedia/qmedia_web
    ports:
      - "3000:3000"
    volumes:
      - ./qmedia_web:/app
    environment:
      - ENV_VAR=value

.gitignore

.gitignore 文件用于指定 Git 应该忽略的文件和目录。以下是一个示例：

# 忽略所有 .log 文件
*.log

# 忽略所有 .env 文件
*.env

# 忽略 node_modules 目录
node_modules/

# 忽略 db 目录
db/

通过以上配置，您可以轻松地启动和管理 Qmedia 项目。