Peppermint 项目安装与使用教程

Peppermint 项目安装与使用教程

peppermint An open source ticket management & help desk solution. A freshdesk alternative 项目地址: https://gitcode.com/gh_mirrors/pe/peppermint

1. 项目目录结构及介绍

Peppermint 是一个开源的帮助台和问题管理系统，其目录结构如下：

• apps/: 包含项目中的应用程序代码。
• packages/: 存放项目依赖的第三方包。
• static/: 存储静态文件，如图片、CSS 和 JavaScript 文件。
• .dockerignore: 指定不应被 Docker 包含的文件和目录。
• .gitignore: 指定不应被 Git 跟踪的文件和目录。
• docker-compose.dev.yml: Docker 开发环境配置文件。
• docker-compose.local.yml: Docker 本地环境配置文件。
• docker-compose.yml: Docker 生产环境配置文件。
• dockerfile: Docker 构建文件。
• ecosystem.config.js: PM2 进程管理器的配置文件。
• license: 项目许可证文件。
• package.json: Node.js 项目配置文件，包括依赖和脚本。
• tsconfig.json: TypeScript 配置文件。
• turbo.json: 项目特定的配置文件。
• yarn.lock: Yarn 锁文件，确保依赖的稳定性。

2. 项目的启动文件介绍

项目的启动主要通过 docker-compose 文件来管理。以下是一些主要的启动文件：

• docker-compose.dev.yml: 用于开发环境的 Docker 配置文件，它定义了服务，例如数据库和应用程序服务，以及它们如何相互连接。

• docker-compose.local.yml: 用于本地测试的 Docker 配置文件，通常与开发环境的配置相似，但可能包含不同的设置以适应本地环境。

• docker-compose.yml: 用于生产环境的 Docker 配置文件，应包含所有生产所需的服务和配置。

• ecosystem.config.js: PM2 的配置文件，用于在 Node.js 环境中启动、监控和管理应用程序。

3. 项目的配置文件介绍

项目中的配置文件主要包括：

• package.json: 包含项目的元数据、依赖关系和脚本。可以通过运行 npm install 来安装依赖项，以及使用 npm run 来执行定义好的脚本。

• docker-compose.yml: 在这个文件中，可以配置数据库服务（如 PostgreSQL），以及应用程序服务。例如，以下是数据库服务的配置：

peppermint_postgres:
  container_name: peppermint_postgres
  image: postgres:latest
  restart: always
  ports:
    - 5432:5432
  volumes:
    - pgdata:/var/lib/postgresql/data
  environment:
    POSTGRES_USER: peppermint
    POSTGRES_PASSWORD: 1234
    POSTGRES_DB: peppermint

• ecosystem.config.js: 例如，以下配置用于启动应用程序服务：

module.exports = {
  apps : [{
    name: 'peppermint',
    script: 'npm start',
    env: {
      NODE_ENV: 'development',
      DB_USERNAME: 'peppermint',
      DB_PASSWORD: '1234',
      DB_HOST: 'peppermint_postgres',
      SECRET: 'peppermint4life'
    }
  }]
};

确保在修改任何配置文件后，正确地重新启动服务以应用更改。

peppermint An open source ticket management & help desk solution. A freshdesk alternative 项目地址: https://gitcode.com/gh_mirrors/pe/peppermint