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

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

1. 项目目录结构及介绍

DocHub 项目的目录结构如下：

dochub/
├── browserslistrc            # 浏览器兼容性配置文件
├── dockerignore             # Docker 忽略文件
├── editorconfig             # 编辑器配置文件
├── eslintignore             # ESLint 忽略文件
├── eslintrc.json            # ESLint 配置文件
├── gitignore                # Git 忽略文件
├── CODEOWNERS               # 代码所有者配置文件
├── CODEOWNERS.EN.md         # 代码所有者英文说明文件
├── CONTRIBUTING.md          # 贡献指南
├── Dockerfile               # Dockerfile 文件
├── LICENSE                  # 许可证文件
├── README.EN.md             # 英文说明文件
├── README.md                # 中文说明文件
├── babel-jest.config.js     # Babel Jest 配置文件
├── babel.config.js          # Babel 配置文件
├── config.d.ts              # TypeScript 配置文件
├── docker-compose.yaml      # Docker Compose 配置文件
├── example.env              # 环境变量示例文件
├── jest.config.js           # Jest 配置文件
├── jest.setup.js            # Jest 设置文件
├── oidc-settings.js         # OIDC 设置文件
├── package-lock.json        # 包锁定文件
├── package.json             # 包管理文件
├── plugins.json             # 插件配置文件
├── tsconfig.json            # TypeScript 配置文件
├── uppml.sh                 # UPPML 脚本文件
├── vue.config.js            # Vue 配置文件
├── vue.lib.js               # Vue 库文件
├── github/workflows/        # GitHub Actions 工作流目录
├── distrib/                 # 分发目录
├── pics/                    # 图片目录
├── plugins/                 # 插件目录
├── public/                  # 公共目录
├── src/                     # 源代码目录
└── tests/                   # 测试目录

2. 项目启动文件介绍

项目的启动文件主要是 docker-compose.yaml，用于配置 Docker 容器。以下是该文件的主要内容：

version: '3'
services:
  dochub:
    build: .
    ports:
      - "8080:80"
    environment:
      - VUE_APP_DOCHUB_GITLAB_URL=https://gitlab.com
      - VUE_APP_DOCHUB_PERSONAL_TOKEN=your_gitlab_token
    volumes:
      - .:/app
      - /app/node_modules

启动步骤

1. 配置环境变量：将 example.env 文件复制并重命名为 .env，然后根据需要修改其中的环境变量。
2. 构建并启动容器：运行以下命令启动 Docker 容器：

docker-compose up --build

启动后，DocHub 将在 http://localhost:8080/main 上可用。

3. 项目配置文件介绍

.env 环境变量文件

.env 文件用于配置环境变量，以下是一些关键的变量：

• VUE_APP_DOCHUB_GITLAB_URL：GitLab 的地址。
• VUE_APP_DOCHUB_PERSONAL_TOKEN：GitLab 的个人访问令牌。

package.json 包管理文件

package.json 文件列出了项目的依赖和脚本，以下是一些重要的部分：

{
  "name": "dochub",
  "version": "1.0.0",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "vue": "^2.6.11",
    "vue-router": "^3.2.0",
    "vuex": "^3.4.0",
    ...
  },
  "devDependencies": {
    "@vue/cli-plugin-eslint": "^4.5.0",
    "@vue/cli-service": "^4.5.0",
    ...
  }
}

vue.config.js Vue 配置文件

vue.config.js 文件用于配置 Vue CLI 的行为，以下是一个示例配置：

module.exports = {
  publicPath: process.env.NODE_ENV === 'production' ? '/dochub/' : '/',
  devServer: {
    proxy: {
      '/api':