Django-helpdesk 技术文档

1. 安装指南

独立安装

对于独立安装，请参考位于 docs/standalone.rst 的文档。

集成安装

要将 django-helpdesk 集成到现有的 Django 应用程序中，请遵循位于 docs/install.rst 和 docs/configuration.rst 的指南。

2. 项目使用说明

django-helpdesk 包含了一个基础的 Django 示例项目，让你可以轻松地进行测试或开发。示例项目位于顶级目录下的 demo/ 文件夹中。

很可能你只需运行以下命令即可启动示例项目服务器（建议在运行前创建一个虚拟环境）：

make rundemo

或者使用 Docker：

docker build . -t demodesk
docker run --rm -v "$PWD:/app" -p 8080:8080 demodesk

然后使用浏览器访问 http://localhost:8080（使用用户 admin 和密码 Test1234 登录）。

有关更多信息以及选项，请阅读 demo/README.rst 文件。

关于 SQLite 和搜索的注意：

示例项目使用 sqlite 作为其数据库。SQLite 不支持大小写不敏感的搜索，因此搜索功能可能不如支持大小写不敏感搜索的其他数据库（如 PostgreSQL 或 MySQL）有效。

尝试使用 sqlite 进行关键字搜索时，会显示一条消息提醒你此缺陷。对此很抱歉，但无法解决这个问题。

3. 项目API使用文档

django-helpdesk 提供了 API 来管理工单。以下是 API 的基本使用方法：

• GET：获取工单列表或单个工单详情。
• POST：创建新的工单。
• PUT：更新现有的工单。
• PATCH：部分更新现有的工单。
• DELETE：删除工单。

要在项目中使用 API，请参考 docs/api.rst 文件中的详细说明。

4. 项目安装方式

开发者环境的设置步骤如下，以贡献代码：

• 从 GitHub 克隆帮助台应用到本地文件系统：

git clone https://github.com/django-helpdesk/django-helpdesk.git

• 安装并激活虚拟环境：

python -m venv .venv && source .venv/bin/activate

• 安装开发所需的要求：

pip install -r requirements.txt -r requirements-dev.txt

• 你也可以安装测试要求：

pip install -r requirements-testing.txt

要停用虚拟环境，使用 deactivate 命令。要重新激活，只需运行：

source .venv/bin/activate

要查看 Makefile 的选项，运行 make 命令。

项目在 CI/CD 流水中执行标准化格式化。要确保正确的格式，运行：

make checkformat

要自动格式化代码，使用：

make format

要运行测试，使用命令行：

make test

有关详细信息，请查看 quicktest.py 文件。如果你需要为新功能创建测试，将你的测试添加到 tests 模块的测试文件中，并在测试虚拟环境中调用它们：

python quicktest.py helpdesk.tests.test_my_new_features -v 2